The IMsgServiceAdmin interface is used to make changes to a message service within a profile.
Header file: | MAPIX.H |
Exposed by: | Message service administration objects |
Implemented by: | MAPI |
Called by: | Client applications |
Interface identifier: | IID_IMsgServiceAdmin |
Pointer type: | LPSERVICEADMIN |
GetLastError | Returns a MAPIERROR structure containing information about the last error that occurred for a message service administration object. |
GetMsgServiceTable | Provides access to the message service's provider table, a listing of the message services in the profile. |
CreateMsgService | Adds a message service to the current profile. |
DeleteMsgService | Deletes a message service from a profile. |
CopyMsgService | Copies a message service into a profile. |
RenameMsgService | Assigns a new name to a message service. |
ConfigureMsgService | Enables a user to reconfigure a message service using the service's configuration property sheet. |
OpenProfileSection | Opens a section of the current profile and returns an IProfSect pointer for further access |
MsgServiceTransportOrder | Sets the order in which transport providers are called to deliver a message. |
AdminProviders | Returns a pointer providing access to a provider administration object. |
SetPrimaryIdentity | Designates a message service to be the supplier of the primary identity for the profile. |
GetProviderTable | Provides access to the provider table, a listing of the service providers in the profile. |
An implementation can get a pointer to an IMsgServiceAdmin interface in two ways: by calling the IMAPISession::AdminServices method or by calling the IProfAdmin::AdminServices method. For clients primarily concerned with profile configuration — for example, control panels — IProfAdmin::AdminServices is the preferred way to get the IMsgServiceAdmin interface because it does not log providers on to the MAPI session. If a client requires the ability to make changes to the active profile, then IMAPISession::AdminServices should be called to get the IMsgServiceAdmin pointer. Clients that are modifying the profile that is active for the session should be designed with the awareness that although MAPI does not allow a profile that is in use to be deleted, there are no safeguards to prevent a client from removing all the message services within the profile.