IXPLogon::OpenStatusEntry

The IXPLogon::OpenStatusEntry method opens the transport provider's status object.

Quick Info

See IXPLogon : IUnknown.

HRESULT OpenStatusEntry(
  LPCIID lpInterface,        
  ULONG ulFlags,             
  ULONG FAR * lpulObjType,   
  LPMAPISTATUS FAR * lppEntry  
);
 

Parameters

lpInterface

[in] Pointer to an interface identifier (IID) for the transport logon object. Passing NULL indicates the IMAPIStatus interface is returned. The lpInterface parameter can also be set to an identifier for an interface for the object.

ulFlags

[in] Bitmask of flags that controls how the status object is opened. The following flag can be set:

MAPI_MODIFY

Requests read/write access. The default interface is read-only.

lpulObjType

[out] Pointer to the type of the opened object.

lppEntry

[out] Pointer to the pointer to the opened status object.

Return Values

S_OK

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

Remarks

The MAPI spooler calls the IXPLogon::OpenStatusEntry method when a client application calls an OpenEntry method for the entry identifier in the transport provider's status table row. OpenStatusEntry opens an object with the IMAPIStatus interface associated with this particular transport provider logon. This object is then used to enable client applications to call IMAPIStatus methods, for example to reconfigure the logon session using the IMAPIStatus::SettingsDialog method, or to validate the state of the logon session using the IMAPIStatus::ValidateState method.

See Also

IMAPIStatus : IMAPIProp