IMSLogon Interface

IID_IMSLogon

{00020313-0000-0000-C000-000000000046}

The IMSLogon interface is used to access resources in a message store logon object.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMSLogon Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error.

Logoff

Logs off a message store provider.

OpenEntry

Opens a folder or message object and returns a pointer to the object to provide further access.

CompareEntryIDs

Compares two entry identifiers to determine if they refer to the same object.

Advise

Registers a message store provider for notifications about changes within the message store.

Unadvise

Removes an object's registration for notification of message store changes previously established with a call to the IMSLogon::Advise method.

OpenStatusEntry

Opens a status object.

GetLastError

FUNCTION IMSLogon_GetLastError ( _
  BYVAL pIMSLogon AS DWORD PTR _
, BYVAL hResultCode AS LONG _
, BYVAL ulFlags AS DWORD _
, BYREF lppMAPIError AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMSLogon[3] USING IMSLogon_GetLastError (pIMSLogon, hResultCode, ulFlags, lppMAPIError) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Logoff

FUNCTION IMSLogon_Logoff ( _
  BYVAL pIMSLogon AS DWORD PTR _
, BYREF lpulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMSLogon[4] USING IMSLogon_Logoff (pIMSLogon, lpulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

OpenEntry

FUNCTION IMSLogon_OpenEntry ( _
  BYVAL pIMSLogon AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYREF lpInterface AS GUID _
, BYVAL ulOpenFlags AS DWORD _
, BYREF lpulObjType AS DWORD _
, BYREF lppUnk AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMSLogon[5] USING IMSLogon_OpenEntry (pIMSLogon, cbEntryID, lpEntryID, lpInterface, ulOpenFlags, lpulObjType, lppUnk) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CompareEntryIDs

FUNCTION IMSLogon_CompareEntryIDs ( _
  BYVAL pIMSLogon AS DWORD PTR _
, BYVAL cbEntryID1 AS DWORD _
, BYVAL lpEntryID1 AS ENTRYID PTR _
, BYVAL cbEntryID2 AS DWORD _
, BYVAL lpEntryID2 AS ENTRYID PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lpulResult AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMSLogon[6] USING IMSLogon_CompareEntryIDs (pIMSLogon, cbEntryID1, lpEntryID1, cbEntryID2, lpEntryID2, ulFlags, lpulResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Advise

FUNCTION IMSLogon_Advise ( _
  BYVAL pIMSLogon AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYVAL ulEventMask AS DWORD _
, BYVAL lpAdviseSink AS DWORD _
, BYREF lpulConnection AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMSLogon[7] USING IMSLogon_Advise (pIMSLogon, cbEntryID, lpEntryID, ulEventMask, lpAdviseSink, lpulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Unadvise

FUNCTION IMSLogon_Unadvise ( _
  BYVAL pIMSLogon AS DWORD PTR _
, BYVAL ulConnection AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMSLogon[8] USING IMSLogon_Unadvise (pIMSLogon, ulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

OpenStatusEntry

FUNCTION MsgLogon_OpenStatusEntry ( _
  BYVAL pIMSLogon 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 @@pIMSLogon[9] USING MsgLogon_OpenStatusEntry (pIMSLogon, lpInterface, ulFlags, lpulObjType, lppEntry) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION