IMSgStore Interface

IID_IMsgStore

{00020306-0000-0000-C000-000000000046}

The IMsgStore interface provides access to message store information and to messages and folders.

This interface inherits from IMAPIProp.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMAPIProp Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error.

SaveChanges

Makes permanent any changes made to an object since the last save operation.

GetProps

Retrieves one or more properties.

GetPropList

Returns property tags for all properties.

OpenProperty

Returns a pointer to an interface to be used to access a property.

SetProps

Updates one or more properties.

DeleteProps

Deletes one or more properties.

CopyTo

Copies or moves all properties, except for specifically excluded properties.

CopyProps

Copies or moves selected properties.

GetNamesFromIDs

Provides the property names that correspond to one or more property identifiers.

GetIDsFromNames

Provides the property identifiers that correspond to one or more property names.

IMSgStore Methods

Description

Advise

Registers to receive notification of specified events affecting the message store.

Unadvise

Cancels the sending of notifications previously set up with a call to the IMsgStore::Advise method.

CompareEntryIDs

Compares two entry identifiers to determine if they refer to the same entry within a message store.

OpenEntry

Opens a folder or message and returns an interface pointer for further access.

SetReceiveFolder

Establishes a folder as the destination for incoming messages of a particular message class.

GetReceiveFolder

Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store.

GetReceiveFolderTable

Provides access to the receive folder table a table with information about all of the receive folders for the message store.

StoreLogoff

Enables the orderly logoff of the message store.

AbortSubmit

Attempts to remove a message from the outgoing queue.

GetOutgoingQueue

Provides access to the outgoing queue table a table with information about all of the messages in the message store's outgoing queue. This method is called only by the MAPI spooler.

SetLockState

Locks or unlocks a message. This method is called only by the MAPI spooler.

FinishedMsg

Enables the message store provider to perform processing on a sent message. This method is called only by the MAPI spooler.

NotifyNewMail

Informs the message store that a new message has arrived. This method is called only by the MAPI spooler.

Advise

FUNCTION IMsgStore_Advise ( _
  BYVAL pIMsgStore 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 @@pIMsgStore[14] USING IMsgStore_Advise (pIMsgStore, cbEntryID, lpEntryID, ulEventMask, lpAdviseSink, lpulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Unadvise

FUNCTION IMsgStore_Unadvise ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYVAL ulConnection AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[15] USING IMsgStore_Unadvise (pIMsgStore, ulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CompareEntryIDs

FUNCTION IMsgStore_CompareEntryIDs ( _
  BYVAL pIMsgStore 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 @@pIMsgStore[16] USING IMsgStore_CompareEntryIDs (pIMsgStore, cbEntryID1, lpEntryID1, cbEntryID2, lpEntryID2, ulFlags, lpulResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

OpenEntry

FUNCTION IMsgStore_OpenEntry ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYREF lpInterface AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lpulObjType AS DWORD _
, BYREF lppUnk AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[17] USING IMsgStore_OpenEntry (pIMsgStore, cbEntryID, lpEntryID, lpInterface, ulFlags, lpulObjType, lppUnk) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetReceiveFolder

FUNCTION IMsgStore_SetReceiveFolder ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYREF lpszMessageClass AS ASCIIZ _
, BYVAL ulFlags AS DWORD _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[18] USING IMsgStore_SetReceiveFolder (pIMsgStore, lpszMessageClass, ulFlags, cbEntryID, lpEntryID) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetReceiveFolder

FUNCTION IMsgStore_GetReceiveFolder ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYREF lpszMessageClass AS ASCIIZ _
, BYVAL ulFlags AS DWORD _
, BYVAL cbEntryID AS DWORD _
, BYREF lpEntryID AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[19] USING IMsgStore_GetReceiveFolder (pIMsgStore, lpszMessageClass, ulFlags, cbEntryID, lpEntryID) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetReceiveFolderTable

FUNCTION IMsgStore_GetReceiveFolderTable ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppTable AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[20] USING IMsgStore_GetReceiveFolderTable (pIMsgStore, ulFlags, lppTable) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

StoreLogoff

FUNCTION IMsgStore_StoreLogoff ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYREF lpulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[21] USING IMsgStore_StoreLogoff (pIMsgStore, lpulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

AbortSubmit

FUNCTION IMsgStore_AbortSubmit ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[22] USING IMsgStore_AbortSubmit (pIMsgStore, cbEntryID, lpEntryID, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetOutgoingQueue

FUNCTION IMsgStore_GetOutgoingQueue ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppTable AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[23] USING IMsgStore_GetOutgoingQueue (pIMsgStore, ulFlags, lppTable) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetLockState

FUNCTION IMsgStore_SetLockState ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYVAL lpMessage AS DWORD _
, BYVAL ulLockState AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[24] USING IMsgStore_SetLockState (pIMsgStore, lpMessage, ulLockState) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FinishedMsg

FUNCTION IMsgStore_FinishedMsg ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[25] USING IMsgStore_FinishedMsg (pIMsgStore, ulFlags, cbEntryID, lpEntryID) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

NotifyNewMail

FUNCTION IMsgStore_NotifyNewMail ( _
  BYVAL pIMsgStore AS DWORD PTR _
, BYREF lpNotification AS NOTIFICATION _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgStore[26] USING IMsgStore_NotifyNewMail (pIMsgStore, lpNotification) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION