IXPLogon::OpenStatusEntry

Last modified: July 23, 2011

Applies to: Outlook

Opens the transport provider's status object.

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

lpInterface

[in] A pointer to an interface identifier (IID) for the transport logon object. Passing NULL returns the IMAPIStatus interface. The lpInterface parameter can also be set to an identifier for an interface for the object.

ulFlags

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

MAPI_MODIFY

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

lpulObjType

[out] A pointer to the type of the opened object.

lppEntry

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

S_OK

The call succeeded and returned the expected value or values.

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 by using the IMAPIStatus::SettingsDialog method, or to validate the state of the logon session by using the IMAPIStatus::ValidateState method).

Show: