IProviderAdmin Interface

IID_IProviderAdmin

{00020325-0000-0000-C000-000000000046}

The IProviderAdmin interface is used to work with service providers within a message service.

Clients can get a pointer to an IProviderAdmin interface by calling IMsgServiceAdmin::AdminProviders; service providers are passed an IProviderAdmin pointer when their message service's entry point function is called.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IProviderAdmin Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error occurring to the provider administration object.

GetProviderTable

Provides access to the message service's provider table a listing of the service providers in the message service.

CreateProvider

Adds a service provider to the message service.

DeleteProvider

Deletes a service provider from the message service.

OpenProfileSection

Opens a profile section from the current profile and returns an IProfSect pointer for further access.

GetLastError

FUNCTION IProviderAdmin_GetLastError ( _
  BYVAL pIProviderAdmin AS DWORD PTR _
, BYVAL hResultCode AS LONG _
, BYVAL ulFlags AS DWORD _
, BYREF lppMAPIError AS DWORD _
  ) AS LONG

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

END FUNCTION

GetProviderTable

FUNCTION IProviderAdmin_GetProviderTable ( _
  BYVAL pIProviderAdmin AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppTable AS DWORD _
  ) AS LONG

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

END FUNCTION

CreateProvider

FUNCTION IProviderAdmin_CreateProvider ( _
  BYVAL pIProviderAdmin AS DWORD PTR _
, BYREF lpszProvider AS ASCIIZ _
, BYVAL cValues AS DWORD _
, BYVAL lpProps AS DWORD _
, BYVAL ulUIParam AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYREF lpUID AS GUID _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIProviderAdmin[5] USING IProviderAdmin_CreateProvider (pIProviderAdmin, lpszProvider, cValues, lpProps, ulUIParam, ulFlags, lpUID) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

DeleteProvider

FUNCTION IProviderAdmin_DeleteProvider ( _
  BYVAL pIProviderAdmin AS DWORD PTR _
, BYREF lpUID AS GUID _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIProviderAdmin[6] USING IProviderAdmin_DeleteProvider (pIProviderAdmin, lpUID) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

OpenProfileSection

FUNCTION IProviderAdmin_OpenProfileSection ( _
  BYVAL pIProviderAdmin AS DWORD PTR _
, BYREF lpUID AS GUID _
, BYREF lpInterface AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lppProfSect AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIProviderAdmin[7] USING IProviderAdmin_OpenProfileSection (pIProviderAdmin, lpUID, lpInterface, ulFlags, lppProfSect) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION