IMAPIStatus : IMAPIProp
Applies to: Office 2010 | Outlook 2010 | Visual Studio
Provides 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.
Header file: |
Mapidefs.h |
Exposed by: |
Status objects |
Implemented by: |
Service providers and MAPI |
Called by: |
Client applications |
Interface identifier: |
IID_IMAPIStatus |
Pointer type: |
LPMAPISTATUS |
Transaction model: |
Nontransacted |
Vtable Order
Confirms the external status information available for the MAPI resource or the service provider. |
|
Displays a property sheet that enables the user to change a service provider's configuration. |
|
Modifies a service provider's password without displaying a user interface. |
|
Forces all messages waiting to be sent or received to be immediately uploaded or downloaded. |
Required properties |
Access |
|---|---|
PR_DISPLAY_NAME (PidTagDisplayName) |
Read/write |
PR_PROVIDER_DISPLAY (PidTagProviderDisplay) |
Read/write |
PR_PROVIDER_DLL_NAME (PidTagProviderDllName) |
Read-only |
PR_RESOURCE_FLAGS (PidTagResourceFlags) |
Read-only |
PR_RESOURCE_METHODS (PidTagResourceMethods) |
Read-only |
PR_RESOURCE_TYPE (PidTagResourceType) |
Read-only |
PR_STATUS_CODE (PidTagStatusCode) |
Read-only |
Remarks
The status objects that MAPI implements support the following methods:
Status object |
Supported methods |
|---|---|
MAPI subsystem |
ValidateState only |
MAPI address book |
ValidateState only |
MAPI spooler |
ValidateState and FlushQueues |
The status objects that MAPI implements are required to have a read-only version of the methods of the IMAPIProp interface and to support the ValidateState method. Transport providers should also support FlushQueues. All providers should support SettingsDialog; support for ChangePassword is optional.
Clients use status objects to perform configuration and to learn about the state of the session. They access a status object by calling the OpenStatusEntry method of a service provider logon object or the IMAPISession::GetStatusTable method to retrieve the status object.