IWMSBroadcastPublishingPoint::get_BroadcastStatus

  • Article

banner art

Previous Next

IWMSBroadcastPublishingPoint::get_BroadcastStatus

The get_BroadcastStatus method retrieves an enumeration value that indicates the status of the broadcast publishing point.

Syntax

  HRESULT get_BroadcastStatus(
  WMS_BROADCAST_PUBLISHING_POINT_STATUS*  pVal
);

Parameters

pVal

[out] Member of a WMS_BROADCAST_PUBLISHING_POINT_STATUS enumeration type that indicates the status of the publishing point. This must be one of the following values.

Value Description
WMS_BROADCAST_PUBLISHING_POINT_STOPPED The publishing point is not currently running.
WMS_BROADCAST_PUBLISHING_POINT_STARTED_WITHOUT_DATA The publishing point has been initialized and the multicast data sinks are transmitting multicast beacons.
WMS_BROADCAST_PUBLISHING_POINT_STARTED The publishing point is running.
WMS_BROADCAST_PUBLISHING_POINT_ARCHIVING The publishing point is archiving content to a file.
WMS_BROADCAST_PUBLISHING_POINT_CHANGE_IN_PROGRESS The publishing point is starting.

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 pVal is a NULL pointer argument.
NS_E_PUBLISHING_POINT_REMOVED 0xC00D145AL The publishing point has already been removed.

Example Code

#include <windows.h>
#include <atlbase.h>    // Includes CComVariant.
#include "wmsserver.h"

// Declare variables and interfaces.
IWMSServer                    *pServer;
IWMSPublishingPoints          *pPubPoints;
IWMSPublishingPoint           *pPubPoint;
IWMSBroadcastPublishingPoint  *pBCPubPoint;

HRESULT         hr;
CComVariant     varIndex;
long            lCount;

// 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 the IWMSPublishingPoints
// interface and retrieve the number of publishing points.
hr = pServer->get_PublishingPoints(&pPubPoints);
if (FAILED(hr)) goto EXIT;
hr = pPubPoints->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;

// Retrieve each publishing point and query the
// IWMSBroadcastPublishingPoint interface.
for (long x = 0; x < lCount; x++)
{
    varIndex = x;
    hr = pPubPoints->get_Item(varIndex, &pPubPoint);
    if (FAILED(hr)) goto EXIT;

    // Retrieve the type of publishing point.
    WMS_PUBLISHING_POINT_TYPE pptType;
    hr = pPubPoint->get_Type(&pptType);
    if (FAILED(hr)) goto EXIT;

    if (pptType == WMS_PUBLISHING_POINT_TYPE_BROADCAST)
    {
        hr = pPubPoint->QueryInterface(IID_IWMSBroadcastPublishingPoint,
                                      (void **)&pBCPubPoint);
        if (FAILED(hr)) goto EXIT;

        // Retrieve the current status of the publishing point.
        // The status is reported as the result of a bitwise OR
        // of any of the designated values.
        WMS_BROADCAST_PUBLISHING_POINT_STATUS ppsStatus;
        hr = pBCPubPoint->get_BroadcastStatus(&ppsStatus);
        if (FAILED(hr)) goto EXIT;

        pBCPubPoint->Release();
    }

    // Release temporary COM objects.
    pPubPoint->Release();
}

EXIT:
    // TODO: Release temporary COM objects and uninitialize COM.

Requirements

Header: wmsserver.h.

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next