IWMSPublishingPoint::get_Players

The get_Players method retrieves an IWMSPlayersIWMSPlayers Interface containing information about connected players.

HRESULT get_Players(
  IWMSPlayers**  pVal
);

Arguments

pVal

[out] Pointer to a pointer to an IWMSPlayers interface.

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.

NS_E_PUBLISHING_POINT_REMOVED

0xC00D145AL

Indicates that the publishing point was already removed.

Remarks

The IWMSPlayers interface contains a collection of IWMSPlayer interfaces that can be used to retrieve information about connected players.

This method calls AddRef internally. To avoid memory leaks, you must call Release when you are finished using the interface.

Example

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

// Declare variables and interfaces.
IWMSServer              *pServer;
IWMSPublishingPoints    *pPubPoints;
IWMSPublishingPoint     *pPubPoint;
IWMSPlayers             *pPlayers;

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 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 currently-
    // connected clients.
    hr = pPubPoint->get_Players(&pPlayers);
    if (FAILED(hr)) goto EXIT;

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

IWMSPlayer Interface

IWMSPlayers Interface

IWMSPublishingPoint Interface