IWMSCPPluginAdmin::get_ControlProtocol

banner art

Previous Next

IWMSCPPluginAdmin::get_ControlProtocol

The get_ControlProtocol method retrieves the protocol name.

Syntax

  HRESULT get_ControlProtocol(
  BSTR*  pbstrProtocol
);

Parameters

pbstrProtocol

[out] Pointer to a BSTR containing the protocol name.

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

Remarks

System plug-ins support the HTTP, MMS, and RTSP protocols.

In Windows Server 2008 operating systems, the MMS protocol is not supported, and Windows Media Services does not provide an MMS Server Control Protocol plug-in.

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;
IWMSCPPluginAdmin       *pCPAdmin;

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 control protocol plug-ins.
hr = pServer->get_ControlProtocols(&pPlugins);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to the IWMSPlugin interface
// of the plug-in to be configured.
varIndex = "WMS RTSP Server Control Protocol";
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_IWMSCPPluginAdmin,
                              (void **)&pCPAdmin);
if (FAILED(hr)) goto EXIT;

// Retrieve the protocol name supported by the plug-in.
hr = pCPAdmin->get_ControlProtocol(&bstrProtocol);
if (FAILED(hr)) goto EXIT;

EXIT:

Requirements

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next