IWMSAdminRealm::put_Realm
Previous | Next |
IWMSAdminRealm::put_Realm
The put_Realm method specifies the name of the realm that is presented to a client when the client is prompted for a user name and password.
Syntax
HRESULT put_Realm( BSTR newRealm );
Parameters
newRealm
[in] BSTR containing the authentication realm. This must not exceed 251 characters.
Return Values
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
Return code | Number | Description |
E_INVALIDARG | 0x80070057 | The newRealm parameter is NULL or exceeds 251 characters. |
Example Code
#include <windows.h> #include <atlbase.h> // Includes CComBSTR and 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; CComBSTR bstrRealm; // 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; // Set the name presented to a client // upon user name and password requests. bstrRealm = "MyRealm"; hr = pAdminRealm->put_Realm(bstrRealm); if (FAILED(hr)) goto EXIT; EXIT: // TODO: Release temporary COM objects and uninitialize COM.
Requirements
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.
See Also
Previous | Next |