GetMailslotInfo
The GetMailslotInfo
function retrieves information about the specified mailslot.
BOOL GetMailslotInfo(
|
HANDLE hMailslot, |
// mailslot handle |
|
LPDWORD lpMaxMessageSize, |
// address of
maximum message size |
|
LPDWORD lpNextSize, |
// address of size
of next message |
|
LPDWORD lpMessageCount, |
// address of
number of messages |
|
LPDWORD lpReadTimeout |
// address of read
time-out |
|
); |
|
Parameters
hMailslot
Identifies a
mailslot. The CreateMailslot
function must create this handle.
lpMaxMessageSize
Points to a
buffer specifying the maximum message size, in bytes, allowed for this
mailslot, when the function returns. This value can be greater than or equal to
the value specified in the cbMaxMsg parameter of the CreateMailslot function that created the
mailslot. This parameter can be NULL.
lpNextSize
Points to a
buffer specifying the size, in bytes, of the next message, when the function
returns. The following value has special meaning:
|
Value |
Meaning |
|
MAILSLOT_NO_MESSAGE |
There is no
next message. |
This
parameter can be NULL.
lpMessageCount
Points to a
buffer specifying the total number of messages waiting to be read, when the
function returns. This parameter can be NULL.
lpReadTimeout
Points to a
buffer specifying the amount of time, in milliseconds, a read operation can
wait for a message to be written to the mailslot before a time-out occurs. This
parameter is filled in when the function returns. This parameter can be NULL.
Return Values
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError.
See Also