GetMailslotInfo 函式 (winbase.h)

擷取指定郵件圖的相關信息。

語法

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

讀取作業可以等候在逾時之前寫入郵件圖的時間量，以毫秒為單位。 這個參數會在函式傳回時填入。 此參數可以是 Null。

傳回值

如果函式成功，則傳回非零的值。

如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	winbase.h (包含 Windows.h)
程式庫	Kernel32.lib
DLL	Kernel32.dll

另請參閱

CreateMailslot

Mailslot 函式

Mailslots 概觀

SetMailslotInfo