IXPLogon::Poll

The IXPLogon::Poll method indicates whether or not the transport provider has received one or more inbound messages.

Quick Info

See IXPLogon : IUnknown.

HRESULT Poll(
  ULONG FAR * lpulIncoming  
);
 

Parameters

lpulIncoming

[out] Value indicating the existence of inbound messages. A nonzero value indicates that there are inbound messages.

Returned Values

S_OK

The call succeeded and has returned the expected value or values.

Remarks

The MAPI spooler periodically calls the IXPLogon::Poll method if the transport provider indicates it must be polled for new messages; it does so by passing the LOGON_SP_POLL flag to the call to the IXPProvider::TransportLogon method at the beginning of a session. If the transport provider indicates in response to the Poll call that there are one or more inbound messages available for it to process, the MAPI spooler calls the IXPLogon::StartMessage method to allow the provider to process the first inbound message. The transport provider indicates inbound messages by setting the value in the Poll lpulIncoming parameter to nonzero.

See Also

IXPLogon::StartMessage, IXPProvider::TransportLogon