WinNOFGetIndication()

This allows the application to received unsolicited indications.

Syntax

int WINAPI WinNOFGetIndication(long buffer,
                               unsigned short *buffer_size,
                               unsigned long timeout);
Parameters
buffer
Pointer to a buffer to receive 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.
WNOFTIMEOUT
Timeout waiting for indication.
WNOFSYSNOTREADY
The underlying network subsystem is not ready for network communication.
WNOFNOTREG
The application is not registered to receive indications.
WNOFBADSIZE
The buffer is too small to receive the indication. Reissue the WinNOFGetIndication call with a large enough buffer. The size of the indication is returned in the buffer_size parameter.
WNOFBADPOINTER
Either the buffer or buffer_size parameter is not valid.
WNOFSYSERROR
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 WinNOFCleanup call
  • The product is stopped
  • A system error occurs
Note:
See also WinNOFRegisterIndicationSink() on page WinNOFRegisterIndicationSink() and WinNOFUnregisterIndicationSink() on page WinNOFUnregisterIndicationSink().