IWMSAdminUnicastSink::get_UDPEnabled

The get_UDPEnabled method retrieves a Boolean value indicating whether the unicast data sink can use UDP when selecting a streaming protocol.

HRESULT get_UDPEnabled(
  VARIANT_BOOL*  pfEnabled
);

Arguments

pfEnabled

[out] Pointer to a VARIANT_BOOL indicating whether UDP is enabled.

Return Value

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 pfEnabled parameter is NULL.

Example

#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;
VARIANT_BOOL    bEnabled;
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;

// Retrieve a Boolean value indicating whether UDP
// can be used as a streaming protocol.
hr = pAdminUnicastSink->get_UDPEnabled(&bEnabled);
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

Reference

IWMSAdminUnicastSink Interface