WinMSGetIndication()

This allows the application to receive unsolicited indications.

Syntax

int WINAPI WinMSGetIndication(long buffer,
                               unsigned short *buffer_size,
                               unsigned long  timeout);

Parameters

buffer: Pointer to a buffer into which to receive the indication.
buffer_size: Size of buffer. Returned: the size of the indication.
timeout: Time to wait for indication in milliseconds.

Returns

The function returns a value indicating whether an indication was received.

0: Indication returned.
WMSTIMEOUT: Timeout waiting for indication.
WMSSYSNOTREADY: The underlying network subsystem is not ready for network communication.
WMSNOTREG: The application is not registered to receive indications.
WMSBADSIZE: The buffer is too small to receive the indication. Reissue the WinMSGetIndication call with a large enough buffer. The size of the indication is returned in the buffer_size parameter.
WMSBADPOINTER: Either the buffer or buffer_size parameter is not valid.
WMSSYSERROR: An unexpected system error has occurred.

Remarks

This is a blocking call, it returns in one of the following circumstances:

An indication is returned
The timeout expires
The application issues a WinMSCleanup call
The product is stopped
A system error occurs

Note: See also WinMSRegisterApplication and WinMSUnregisterApplication.