Share via


IMSLogon::OpenStatusEntry

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Opens a status object.

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

Parameters

  • lpInterface
    [in] A pointer to the interface identifier (IID) for the status object to open. Passing NULL indicates the standard interface for the object is returned (in this case, the IMAPIStatus interface). The lpInterface parameter can also be set to an identifier for an appropriate 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. By default, objects are created with read-only permission, and client applications should not work on the assumption that read/write permission has been granted.
  • lpulObjType
    [out] A pointer to the type of the opened object.

  • lppEntry
    [out] A pointer to the pointer to the opened object.

Return Value

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

Remarks

Message store providers implement the IMSLogon::OpenStatusEntry method to open a status object. This status object is then used to enable clients to call IMAPIStatus methods. For example, clients can use the IMAPIStatus::SettingsDialog method to reconfigure the message store logon session or the IMAPIStatus::ValidateState method to validate the state of the message store logon session.

See Also

Reference

IMAPIStatus : IMAPIProp

IMAPIStatus::SettingsDialog

IMAPIStatus::ValidateState

IMSLogon : IUnknown