IWMSPublishingPointTotalCounters::get_Advertisements

banner art
PreviousNext

IWMSPublishingPointTotalCounters::get_Advertisements

The get_Advertisements method retrieves the cumulative number of advertisements that have been streamed from playlists since the last reset.

Syntax

HRESULT get_Advertisements(
  long*  pVal
);

Parameters

pVal

[out] Pointer to a long containing the cumulative number of advertisements that have been streamed.

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 Indicates that pVal is a NULL pointer argument.

Remarks

When the server starts streaming from a playlist in which the role attribute has been set to "Advertisement," the counters should be updated. The value specified for the role attribute can be accessed through the presentation context WMS_PRESENT_PLAYLIST_ENTRY_ROLE property.

Example Code

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

// Declare variables and interfaces.
IWMSServer                          *pServer;
IWMSPublishingPoints                *pPubPoints;
IWMSPublishingPoint                 *pPubPoint;
IWMSPublishingPointTotalCounters    *pTotalCounters;

HRESULT         hr;
CComVariant     varIndex;
long            lCount;
long            lValue;

// 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 total count of publishing points.
hr = pServer->get_PublishingPoints(&pPubPoints);
if (FAILED(hr)) goto EXIT;
hr = pPubPoints->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;

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

    // Retrieve the total number of advertisements
    // streamed since the start time.
    hr = pTotalCounters->get_Advertisements(&lValue);
    if (FAILED(hr)) goto EXIT;

    // Release temporary COM objects.
    pPubPoint->Release();
    pTotalCounters->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

PreviousNext
Show:
© 2014 Microsoft