IWMSAdminNetworkDataSourcePlugin::AddUDPPortRange

banner art

Previous Next

IWMSAdminNetworkDataSourcePlugin::AddUDPPortRange

The AddUDPPortRange method adds a range of UDP/TCP port numbers that can be used by the data source plug-in to receive data.

Syntax

  HRESULT AddUDPPortRange(
  long  newLowerBound,
  long  newUpperBound
);

Parameters

newLowerBound

[in] long specifying a new value for lower bound. This value cannot be zero.

newUpperBound

[in] long specifying a new value for upper bound. This value cannot be zero.

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 newLowerBound parameter is zero, the newUpperBound parameter is zero, you specified a range that has less than 4 ports, or the newLowerBound parameter contains an odd number and you specified a range that has less than 5 port numbers.

Remarks

The range that you specify must contain at least 4 port numbers. If the newLowerBound parameter contains an odd number, you must specify a range that contains at least 5 ports.

Example Code

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

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 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;

// Add an available port range of 30-37, inclusive.
hr = pAdminNetDataSrc->AddUDPPortRange(30, 37);
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
  • Last updated on