IWMSPublishingPointPeakCounters::get_OutgoingDistributionAllocatedBandwidth

The get_OutgoingDistributionAllocatedBandwidth method retrieves the maximum bandwidth, in Kbps, that has been allocated to a distribution connection.

HRESULT get_OutgoingDistributionAllocatedBandwidth(
  long*  pVal
);

Arguments

pVal	[out] Pointer to a long containing the maximum allocated bandwidth.

Return Value

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

You can reset the pVal parameter to the current value by calling the IWMSPublishingPointPeakCounters::Reset method.

Example

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

// Declare variables and interfaces.
IWMSServer                      *pServer;
IWMSPublishingPoints            *pPubPoints;
IWMSPublishingPoint             *pPubPoint;
IWMSPublishingPointPeakCounters *pPeakCounters;

HRESULT         hr;
DATE            dtTime;
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 a pointer to a list of peak statistics
    // for the publishing point.
    hr = pPubPoint->get_PeakCounters(&pPeakCounters);
    if (FAILED(hr)) goto EXIT;

    // Retrieve the maximum distribution bandwidth used
    // since the start time.
    hr = pPeakCounters->get_OutgoingDistributionAllocatedBandwidth(
                                                            &lValue);
    if (FAILED(hr)) goto EXIT;

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

Reference

IWMSPublishingPointPeakCounters Interface