SetMailslotInfo 関数 (winbase.h)

指定した mailslot で読み取り操作に使用されるタイムアウト値を設定します。

構文

BOOL SetMailslotInfo(
  [in] HANDLE hMailslot,
  [in] DWORD  lReadTimeout
);

[in] hMailslot

mailslot へのハンドル。 CreateMailslot 関数は、このハンドルを作成する必要があります。

[in] lReadTimeout

タイムアウトが発生するまでのメッセージが mailslot に書き込まれるまで読み取り操作が待機できる時間 (ミリ秒単位)。次の値は特別な意味を持ちます。

値	説明
0	メッセージが存在しない場合は、直ちにを返します。 (システムは、即時の戻り値をエラーとして扱いません。
MAILSLOT_WAIT_FOREVER ((DWORD)-1)	メッセージを無期限に待機します。

このタイムアウト値は、後続のすべての読み取り操作と、継承されたすべての mailslot ハンドルに適用されます。

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

読み取り操作で mailslot によって使用される初期タイムアウト値は、通常、 mailslot の作成時に CreateMailslot によって設定されます。


サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winbase.h (Windows.h を含む)
Library	Kernel32.lib
[DLL]	Kernel32.dll