IMsgServiceAdmin Interface

IID_IMsgServiceAdmin

{00020325-0000-0000-C000-000000000046}

The IMsgServiceAdmin interface is used to make changes to a message service within a profile.

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.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMsgServiceAdmin Methods

Description

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.

GetLastError

FUNCTION IMsgServiceAdmin_GetLastError ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYVAL hResultCode AS LONG _
, BYVAL ulFlags AS DWORD _
, BYREF lppMAPIError AS DWORD _
  ) AS LONG

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

END FUNCTION

GetMsgServiceTable

FUNCTION IMsgServiceAdmin_GetMsgServiceTable ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppTable AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[4] USING IMsgServiceAdmin_GetMsgServiceTable (pIMsgServiceAdmin, ulFlags, lppTable) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CreateMsgService

FUNCTION IMsgServiceAdmin_CreateMsgService ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpszService AS ASCIIZ _
, BYREF lpszDisplayName AS ASCIIZ _
, BYVAL ulUIParam AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[5] USING IMsgServiceAdmin_CreateMsgService (pIMsgServiceAdmin, lpszService, lpszDisplayName, ulUIParam, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

DeleteMsgService

FUNCTION IMsgServiceAdmin_DeleteMsgService ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpuid AS GUID _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[6] USING IMsgServiceAdmin_DeleteMsgService (pIMsgServiceAdmin, lpuid) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

CopyMsgService

FUNCTION IMsgServiceAdmin_CopyMsgService ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpuid AS GUID _
, BYREF lpszDisplayName AS ASCIIZ _
, BYREF lpInterfaceToCopy AS GUID _
, BYREF lpInterfaceDst AS GUID _
, BYVAL ulUIParam AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[7] USING IMsgServiceAdmin_CopyMsgService (pIMsgServiceAdmin, lpuid, lpszDisplayName, lpInterfaceToCopy, lpInterfaceDst, ulUIParam, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

RenameMsgService

FUNCTION IMsgServiceAdmin_RenameMsgService ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpuid AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lpszDisplayName AS ASCIIZ _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[8] USING IMsgServiceAdmin_RenameMsgService (pIMsgServiceAdmin, lpUID, ulFlags, lpszDisplayName) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

ConfigureMsgService

FUNCTION IMsgServiceAdmin_ConfigureMsgService ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpuid AS GUID _
, BYVAL ulUIParam AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYVAL cValues AS DWORD _
, BYVAL lpProps AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[9] USING IMsgServiceAdmin_ConfigureMsgService (pIMsgServiceAdmin, lpUID, ulUIParam, ulFlags, cValues, lpProps) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

OpenProfileSection

FUNCTION IMsgServiceAdmin_OpenProfileSection ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpuid AS GUID _
, BYREF lpInterface AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYREF lppProfSect AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[10] USING IMsgServiceAdmin_OpenProfileSection (pIMsgServiceAdmin, lpUID, lpInterface, ulFlags, lppProfSect) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MsgServiceTransportOrder

FUNCTION IMsgServiceAdmin_MsgServiceTransportOrder ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYVAL cUID AS DWORD _
, BYVAL lpUIDList AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[11] USING IMsgServiceAdmin_MsgServiceTransportOrder (pIMsgServiceAdmin, cUID, lpUIDList, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

AdminProviders

FUNCTION IMsgServiceAdmin_AdminProviders ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpuid AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lppProviderAdmin AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[12] USING IMsgServiceAdmin_AdminProviders (pIMsgServiceAdmin, lpUID, ulFlags, lppProviderAdmin) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetPrimaryIdentity

FUNCTION IMsgServiceAdmin_SetPrimaryIdentity ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYREF lpuid AS GUID _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[13] USING IMsgServiceAdmin_SetPrimaryIdentity (pIMsgServiceAdmin, lpUID, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetProviderTable

FUNCTION IMsgServiceAdmin_GetProviderTable ( _
  BYVAL pIMsgServiceAdmin AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppTable AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMsgServiceAdmin[14] USING IMsgServiceAdmin_GetProviderTable (pIMsgServiceAdmin, ulFlags, lppTable) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION