IXPLogon Interface

IID_IXPLogon

{00020315-0000-0000-C000-000000000046}

The IXPLogon interface is used to give the MAPI spooler access to a transport provider.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IXPLogon Methods

Description

AddressTypes

Returns the types of recipients that the transport provider handles.

RegisterOptions

Returns the options that are supported by the transport provider for an address type to the MAPI spooler.

TransportNotify

Signals the occurrence of an event about which the transport provider has requested notification.

Idle

Indicates that the system is idle, allowing the transport provider to perform low-priority operations.

TransportLogoff

Initiates the logoff process.

SubmitMessage

Indicates that the MAPI spooler has a message for the transport provider to deliver.

EndMessage

Informs the transport provider that the MAPI spooler has completed its processing on an outbound message.

Poll

Indicates whether or not the transport provider has received one or more inbound messages.

StartMessage

Initiates the transfer of an inbound message from the transport provider to the MAPI spooler.

OpenStatusEntry

Opens the transport provider's status object.

ValidState

Checks the transport provider's external status.

FlushQueues

Requests that the transport provider immediately deliver all pending inbound or outbound messages.

AddressTypes

FUNCTION IXPLogon_AddressTypes ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYREF lpulFlags AS DWORD _
, BYREF lpcAdrType AS DWORD _
, BYREF lpppszAdrTypeArray AS DWORD _
, BYREF lpcMAPIUID AS DWORD _
, BYREF lpppUIDArray AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[3] USING IXPLogon_AddressTypes (pIXPLogon, lpulFlags, lpcAdrType, lpppszAdrTypeArray, lpcMAPIUID, lpppUIDArray) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

RegisterOptions

FUNCTION IXPLogon_RegisterOptions ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYREF lpulFlags AS DWORD _
, BYREF lpcOptions AS DWORD _
, BYREF lppOptions AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[4] USING IXPLogon_RegisterOptions (pIXPLogon, lpulFlags, lpcOptions, lppOptions) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

TransportNotify

FUNCTION IXPLogon_TransportNotify ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYREF lpulFlags AS DWORD _
, BYREF lppvData AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[5] USING IXPLogon_TransportNotify (pIXPLogon, lpulFlags, lppvData) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Idle

FUNCTION IXPLogon_Idle ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[6] USING IXPLogon_Idle (pIXPLogon, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Logoff

FUNCTION IXPLogon_TransportLogoff ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[7] USING IXPLogon_TransportLogoff (pIXPLogon, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SubmitMessage

FUNCTION IXPLogon_SubmitMessage ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYVAL lpMessage AS DWORD _
, BYREF lpulMsgRef AS DWORD _
, BYREF lpulReturnParm AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[8] USING IXPLogon_SubmitMessage (pIXPLogon, ulFlags, lpMessage, lpulMsgRef, lpulReturnParm) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

EndMessage

FUNCTION IXPLogon_EndMessage ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYVAL ulMsgRef AS DWORD _
, BYREF lpulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[9] USING IXPLogon_EndMessage (pIXPLogon, ulMsgRef, lpulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Poll

FUNCTION IXPLogon_Poll ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYREF lpulIncoming AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[10] USING IXPLogon_Poll (pIXPLogon, lpulIncoming) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

StartMessage

FUNCTION IXPLogon_StartMessage ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYVAL lpMessage AS DWORD _
, BYREF lpulMsgRef AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[11] USING IXPLogon_StartMessage (pIXPLogon, ulFlags, lpMessage, lpulMsgRef) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

OpenStatusEntry

FUNCTION IXPLogon_OpenStatusEntry ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYREF lpInterface AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lpulObjType AS DWORD _
, BYREF lppEntry AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[12] USING IXPLogon_OpenStatusEntry (pIXPLogon, lpInterface, ulFlags, lpulObjType, lppEntry) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

ValidateState

FUNCTION IXPLogon_ValidateState ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYVAL ulUIParam AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[13] USING IXPLogon_ValidateState (pIXPLogon, ulUIParam, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

FlushQueues

FUNCTION IXPLogon_FlushQueues ( _
  BYVAL pIXPLogon AS DWORD PTR _
, BYVAL ulUIParam AS DWORD _
, BYVAL cbTargetTransport AS DWORD _
, BYVAL lpTargetTransport AS ENTRYID PTR _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIXPLogon[14] USING IXPLogon_FlushQueues (pIXPLogon, ulUIParam, cbTargetTransport, lpTargetTransport, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION