<Return[G]><Top>

GetNamedPipeInfo

Declare Function Api_GetNamedPipeInfo& Lib "kernel32" Alias "GetNamedPipeInfo" (ByVal hNamedPipe&, lpFlags&, lpOutBufferSize&, lpInBufferSize&, lpMaxInstances&)

Declare Function GetNamedPipeInfo Lib "kernel32" Alias "GetNamedPipeInfo" (ByVal hNamedPipe As Long, lpFlags As Long, lpOutBufferSize As Long, lpInBufferSize As Long, lpMaxInstances As Long) As Long

指定された名前付きパイプに関する情報を取得する。

パラメータ
hNamedPipe
    名前付きパイプのインスタンスのハンドルを指定する。このハンドルは、名前付きパイプに対する GENERIC_READ アクセスを持っていなけ

    ればならない。
    Windows NT/2000:このパラメータで、CreatePipe 関数が返した名前なしパイプのハンドルを指定することもできる。
lpFlags
    1 個の変数へのポインタを指定する。関数から制御が返ると、この変数に、名前付きパイプのタイプが格納される。タイプは、次の値の組

    み合わせになる。この情報が不要な場合、NULL を指定する。

    値                                  

意味                                                                                                                  

    PIPE_CLIENT_END

指定されたハンドルは、名前付きパイプのインスタンスのクライアント側を指している。

    PIPE_SERVER_END

 

指定されたハンドルは、名前付きパイプのインスタンスのサーバー側を指している。

    PIPE_TYPE_BYTE

指定された名前付きパイプは、バイトタイプである。

    PIPE_TYPE_MESSAGE

指定された名前付きパイプは、メッセージタイプである。

lpOutBufferSize
    1 個の変数へのポインタを指定する。関数から制御が返ると、この変数に、出力バッファのサイズがバイト単位で格納される。この情報が

    不要な場合、NULL を指定する。
lpInBufferSize
    1 個の変数へのポインタを指定する。関数から制御が返ると、この変数に、入力バッファのサイズがバイト単位で格納される。この情報が

    不要な場合、NULL を指定する。
lpMaxInstances
    1 個の変数へのポインタを指定する。関数から制御が返ると、この変数に、作成できるパイプインスタンスの最大数が格納される。

    PIPE_UNLIMITED_INSTANCES(Winbase.h で 255 と定義されている)が格納された場合、システムのリソースが利用できる限り、イン

    スタンスを作成できることを意味する。この情報が不要な場合、NULL を指定する。

戻り値
    関数が成功すると、0 以外の値が返る。
    関数が失敗すると、0 が返る。拡張エラー情報を取得するには、 関数を使う。