IMsgServiceAdmin::AdminProviders

The IMsgServiceAdmin::AdminProviders method returns a pointer providing access to a provider administration object.

Quick Info

HRESULT AdminProviders(
  LPMAPIUID lpUID,                        
  ULONG ulFlags,                          
  LPPROVIDERADMIN FAR * lppProviderAdmin  
);

Parameters

lpUID

[in] Pointer to the MAPIUID structure holding the unique identifier for the message service to be administered.

ulFlags

[in] Bitmask of flags that controls the type of the passed-in string. The following flag can be set:

MAPI_UNICODE: The passed-in string is in Unicode format. If the MAPI_UNICODE flag is not set, the string is in ANSI format.

lppProviderAdmin

[out] Pointer to a pointer to a provider administration object.

Return Values

S_OK: The provider administration object was successfully returned.
MAPI_E_NOT_FOUND: The MAPIUID pointed to by lpUID does not exist.

Remarks

The IMsgServiceAdmin::AdminProviders method provides access to a provider administration object. A provider administration object — an object that supports the IProviderAdmin interface — allows clients to add service providers to a message service, delete service providers from a message service, open profile sections, and access the message service provider table.

The types of changes that can actually be made to a message service while the profile is in use depend on the message service. However, most message services do not support changes such as adding and deleting providers while the profile is in use.

Notes to Callers

To retrieve the MAPIUID for the message service to administer, retrieve the PR_SERVICE_UID column from the message service's row in the message service table. See the procedure outlined in IMsgServiceAdmin::CreateMsgService for more information.