SetMailslotInfo
The SetMailslotInfo
function sets the time-out value used by the specified mailslot for a read
operation.
BOOL SetMailslotInfo(
|
HANDLE hMailslot, |
// mailslot handle |
|
DWORD lReadTimeout |
// read time-out |
|
); |
|
Parameters
hMailslot
Identifies a
mailslot. The CreateMailslot
function must create this handle.
lReadTimeout
Specifies 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. The following values have
special meanings:
|
Value |
Meaning |
|
0 |
Returns
immediately if no message is present. (The system does not treat an immediate
return as an error.) |
|
MAILSLOT_WAIT_FOREVER |
Waits
forever for a message. |
This time-out
value applies to all subsequent read operations and to all inherited mailslot
handles.
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.
Remarks
The initial
time-out value used by a mailslot for a read operation is typically set by CreateMailslot
when the mailslot is created.
See Also