IMAPIStatus Interface

IID_IMAPIStatus

{00020305-0000-0000-C000-000000000046}

MAPI implements the IMAPIStatus interface to provide status information about the MAPI subsystem, the integrated address book and the MAPI spooler. A service provider implements IMAPIStatus to supply information about its own status.

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.

IMAPIStatus Methods

Description

ValidateState

Confirms the external status information available for the MAPI resource or the service provider. This method is supported in all status objects.

SettingsDialog

Displays a property sheet enabling the user to change a service provider's configuration. This method is not supported in status objects implemented by MAPI.

ChangePassword

Modifies a service provider's password without displaying a user interface. This method is optionally supported in status objects implemented by service providers.

FlushQueues

Forces all messages waiting to be sent or received to be immediately uploaded or downloaded. This method is supported by the MAPI spooler status object and status objects implemented by transport providers.

ValidateState

FUNCTION IMAPIStatus_ValidateState ( _
  BYVAL pIMAPIStatus AS DWORD PTR _
, BYVAL ulUIParam AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIStatus[14] USING IMAPIStatus_ValidateState (pIMAPIStatus, ulUIParam, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SettingsDialog

FUNCTION IMAPIStatus_SettingsDialog ( _
  BYVAL pIMAPIStatus AS DWORD PTR _
, BYVAL ulUIParam AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIStatus[15] USING IMAPIStatus_SettingsDialog (pIMAPIStatus, ulUIParam, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ChangePassword

FUNCTION IMAPIStatus_ChangePassword ( _
  BYVAL pIMAPIStatus AS DWORD PTR _
, BYREF lpOldPass AS ASCIIZ _
, BYREF lpNewPass AS ASCIIZ _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIStatus[16] USING IMAPIStatus_ChangePassword (pIMAPIStatus, lpOldPass, lpNewPass, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FlushQueues

FUNCTION IMAPIStatus_FlushQueues ( _
  BYVAL pIMAPIStatus AS DWORD PTR _
, BYVAL ulUIParam AS DWORD _
, BYVAL cbTargetTransport AS DWORD _
, BYVAL lpTargetTransport AS ENTRYID PTR _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIStatus[17] USING IMAPIStatus_FlushQueues (pIMAPIStatus, ulUIParam, cbTargetTransport, lpTargetTransport, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION