GetMailslotInfo 関数 (winbase.h)

指定した mailslot に関する情報を取得します。

構文

BOOL GetMailslotInfo(
  [in]            HANDLE  hMailslot,
  [out, optional] LPDWORD lpMaxMessageSize,
  [out, optional] LPDWORD lpNextSize,
  [out, optional] LPDWORD lpMessageCount,
  [out, optional] LPDWORD lpReadTimeout
);

パラメーター

[in] hMailslot

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

[out, optional] lpMaxMessageSize

この mailslot で許可される最大メッセージ サイズ (バイト単位)。 この値は、mailslot を作成した CreateMailslot 関数の cbMaxMsg パラメーターで指定された値以上にすることができます。 このパラメーターは、NULL でもかまいません。

[out, optional] lpNextSize

次のメッセージのサイズ (バイト単位)。 次の値は特別な意味を持ちます。

値	意味
MAILSLOT_NO_MESSAGE ((DWORD)-1)	次のメッセージはありません。

 

このパラメーターは、NULL でもかまいません。

[out, optional] lpMessageCount

関数が戻るときに読み取りを待機しているメッセージの合計数。 このパラメーターは、NULL でもかまいません。

[out, optional] lpReadTimeout

読み取り操作が mailslot にメッセージが書き込まれるのを待ってからタイムアウトが発生するまでの時間 (ミリ秒単位)。 このパラメーターは、関数が戻るときに入力されます。 このパラメーターは、NULL でもかまいません。

戻り値

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

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

要件

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

関連項目

CreateMailslot

Mailslot 関数

Mailslots の概要

SetMailslotInfo