<Return[G]><Top>

SetMailslotInfo

Declare Function Api_SetMailslotInfo& Lib "kernel32" Alias "SetMailslotInfo" (ByVal hMailslot&, ByVal lReadTimeout&)

Declare Function SetMailslotInfo Lib "kernel32" Alias "SetMailslotInfo" (ByVal hMailslot As Long, ByVal lReadTimeout As Long) As Long

指定されたメールスロットのメッセージ読み取りのタイムアウト値を設定する。

パラメータ
hMailslot
    ［入力］メールスロットのハンドルを指定する。CreateMailslot 関数を使って、このハンドルを作成しなければならない。
lReadTimeout
    ［入力］メッセージ読み取りのタイムアウト値を、ミリ秒(1,000 分の 1 秒)単位で指定する。次の値には特別な意味がある。

    値                                           

意味                                                                 

    0

メッセージが存在しないときは、即座に制御を返す(この場合、エラーにはならない)。

    MAILSLOT_WAIT_FOREVER

メッセージが送信されるまで待ち続ける。

    このタイムアウト値は、それ以降のすべての読み取り操作と継承されたすべてのメールスロットハンドルへ適用される。

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

解説
    通常は、CreateMailslot 関数を使ってメールスロットを作成する際に、最初のメッセージ読み取りタイムアウト値を設定する。