Share via

IWMSAdminUnicastSink::put_MaximumPacketSize

  • Article

banner art

Previous Next

IWMSAdminUnicastSink::put_MaximumPacketSize

The put_MaximumPacketSize method specifies the maximum packet size that can be sent by the unicast data sink.

Syntax

  HRESULT put_MaximumPacketSize(
  long  dwMaxMtu
);

Parameters

dwMaxMtu

[in] long containing the maximum packet size.

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_MTU_RANGE 0xC00D1586 The dwMaxMtu parameter is less than 100 or greater than 65,535.

Remarks

The maximum packet size that can be sent is 65,535 bytes. The minimum is 100 bytes. A value of zero indicates that the default size in the file is used.

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;
IWMSAdminUnicastSink  *pAdminUnicastSink;

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

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

// Set the maximum packet size that can be
// sent by the unicast data sink.
hr = pAdminUnicastSink->put_MaximumPacketSize(300);
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