IWMSIPAdmin::get_AccessListOptions

banner art

Previous Next

IWMSIPAdmin::get_AccessListOptions

The get_AccessListOptions method retrieves an enumeration value indicating the default access permissions for unspecified IP addresses.

Syntax

  HRESULT get_AccessListOptions(
  
  WMS_IP_ACCESS_OPTIONS*
  
  AccessOptions
  
  );

Parameters

pAccessOptions

[out] Pointer to a WMS_IP_ACCESS_OPTIONS enumeration value indicating the default access permissions for unspecified IP addresses. This must be one of the following values.

Value Description
WMS_IP_ACCESS_ALLOW_AND_DISALLOW Unspecified IP addresses are ignored.
WMS_IP_ACCESS_ALLOW_BY_DEFAULT Unspecified IP addresses are authorized by default.
WMS_IP_ACCESS_DISALLOW_BY_DEFAULT Unspecified IP addresses are rejected by default.

Return Values

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

Return code Number Description
E_POINTER 0x80004003 The pAccessOptions parameter is NULL.

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;
IWMSIPAdmin     *pIPAdmin;

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 event handler plug-ins.
hr = pServer->get_EventHandlers(&pPlugins);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to the IWMSPlugin interface
// of the plug-in to be configured.
varIndex = "WMS IP Address Authorization";
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_IWMSIPAdmin,
                              (void **)&pIPAdmin);
if (FAILED(hr)) goto EXIT;

// Retrieve an enumeration value indicating
// how the plug-in handles unspecified IP addresses.
WMS_IP_ACCESS_OPTIONS aoAccessOptions;
hr = pIPAdmin->get_AccessListOptions(&aoAccessOptions);
if (FAILED(hr)) goto EXIT;

EXIT:

Requirements

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next