IWMSAdminRealm Interface

banner art

Previous Next

IWMSAdminRealm Interface

The IWMSAdminRealm interface is exposed by the WMS Digest Authentication plug-in. The interface can be used to specify a realm name for your site, to distinguish it from other sites.

In addition to the methods inherited from IDispatch, the IWMSAdminRealm interface exposes the following methods.

Method Description
get_Realm Retrieves the name of the realm that is presented to a client when the client is prompted for a user name and password. The realm string is used to distinguish one site from another.
put_Realm Specifies the name of the realm that is presented to a client when the client is prompted for a user name and password.

Example Code

The following example illustrates how to retrieve a pointer to an IWMSAdminRealm interface.

#include <windows.h>
#include <atlbase.h>    // Includes CComVariant.

// To access system plug-in interfaces, the
// entire type library must be imported as shown.
#import "WMSServerTypeLib.dll" no_namespace named_guids \
                               raw_interfaces_only

// Declare variables and interfaces.
IWMSServer      *pServer;
IWMSPlugins     *pPlugins;
IWMSPlugin      *pPlugin;
IDispatch       *pDispatch;
IWMSAdminRealm  *pAdminRealm;

HRESULT         hr;
CComVariant     varIndex;

// Initialize the COM library and retrieve a pointer
// to an IWMSServer interface.
hr = CoInitialize(NULL);
hr = CoCreateInstance(CLSID_WMSServer,
                      NULL,
                      CLSCTX_ALL,
                      IID_IWMSServer,
                      (void **)&pServer);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to an IWMSPlugins interface
// containing authentication plug-ins.
hr = pServer->get_Authenticators(&pPlugins);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to the IWMSPlugin interface
// of the plug-in to be configured.
varIndex = "WMS Digest Authentication";
hr = pPlugins->get_Item(varIndex, &pPlugin);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to the custom interface
// of the plug-in.
hr = pPlugin->get_CustomInterface(&pDispatch);
if (FAILED(hr)) goto EXIT;

// Query the specific administration interface
// for the plug-in.
hr = pDispatch->QueryInterface(IID_IWMSAdminRealm,
                              (void **)&pAdminRealm);
if (FAILED(hr)) goto EXIT;

EXIT:
    // TODO: Release temporary COM objects and uninitialize COM.

See Also

Previous Next