<Return[G]><Top>

GetMailslotInfo

Declare Function Api_GetMailslotInfo& Lib "kernel32" Alias "GetMailslotInfo" (ByVal hMailslot&, lpMaxMessageSize&, lpNextSize&, lpMessageCount&, lpReadTimeout&)

Declare Function GetMailslotInfo Lib "kernel32" Alias "GetMailslotInfo" (ByVal hMailslot As Long, lpMaxMessageSize As Long, lpNextSize As Long, lpMessageCount As Long, lpReadTimeout As Long) As Long

指定されたメールスロットの情報を取得する。

パラメータ
hMailslot
    [入力]メールスロットのハンドルを指定する。CreateMailslot 関数を使ってこのハンドルを作成しなければならない。
lpMaxMessageSize
    [入力]この関数から制御が返ったときに、メールスロットで認められる最大メッセージサイズを指定するバッファへのポインタを指定する。こ

    の値は、このメールスロットを作成した CreateMailslot 関数の cbMaxMsg パラメータで指定した値と等しいか、それより大きな値になる。こ

    の情報が不要なときは、NULL を指定する。
lpNextSize
    [入力]この関数から制御が返ったときに、次のメッセージのサイズをバイト単位で指定するバッファへのポインタを指定する。次の値には

    特別な意味がある。

    値                                           

意味                                                                 

    MAILSLOT_NO_MESSAGE

次のメッセージはない。

lpMessageCount
    [入力]この関数から制御が返ったときに、読み取りを待っているメッセージの総数を指定するバッファへのポインタを指定する。この情報が

    不要なときは、NULL を指定する。
lpReadTimeout
    [入力]メッセージ読み取りのタイムアウト値を、ミリ秒(1,000 分の 1 秒)単位で指定する。この関数から制御が返ったときに、このパラメー

    タにタイムアウト値が書き込まれている。この情報が不要なときは、NULL を指定する。

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