IWMSAdminNetworkDataSourcePlugin::SetProxySettings

  • Article

banner art

Previous Next

IWMSAdminNetworkDataSourcePlugin::SetProxySettings

The SetProxySettings method specifies an enumeration value indicating the proxy mode for a particular protocol.

Syntax

  HRESULT SetProxySettings(
  BSTR  bstrProtocol,
  WMS_PROXY_SETTINGS  newVal
);

Parameters

bstrProtocol

[in] BSTR containing the protocol. This must be HTTP or RTSP.

newVal

[in] Member of a WMS_PROXY_SETTINGS enumeration type. This must be one of the following values.

Value Description
WMS_PROXY_SETTING_NONE There is no proxy.
WMS_PROXY_SETTING_MANUAL A proxy must be defined by calling the put_ProxyHostName and put_ProxyPort methods.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Number Description
NS_E_INVALID_REQUEST 0xC00D002B The bstrProtocol parameter must be HTTP or RTSP.

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;
IWMSAdminNetworkDataSourcePlugin *pAdminNetDataSrc;

HRESULT         hr;
CComVariant     varIndex;
CComBSTR        bstrProtocol;

// 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 data source plug-ins.
hr = pServer->get_DataSources(&pPlugins);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to the IWMSPlugin interface
// of the plug-in to be configured.
varIndex = "WMS Network Data Source";
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_IWMSAdminNetworkDataSourcePlugin,
                              (void **)&pAdminNetDataSrc);
if (FAILED(hr)) goto EXIT;

// Set proxy mode information for the HTTP protocol.
bstrProtocol = "HTTP";
hr = pAdminNetDataSrc->SetProxySettings(bstrProtocol,
                                         WMS_PROXY_SETTINGS_MANUAL);
if (FAILED(hr)) goto EXIT;

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

Requirements

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also

Previous Next