Share via

IWMSServer::get_Players

  • Article

banner art

Previous Next

IWMSServer::get_Players

The get_Players method retrieves an IWMSPlayers interface containing a collection of IWMSPlayer interfaces. Each object in the collection contains specific information about a connected client.

Syntax

  HRESULT get_Players(
  IWMSPlayers**  pVal
);

Parameters

pVal

[out] Pointer to a pointer to the retrieved IWMSPlayers collection.

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

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

Each IWMSPlayer interface contains client information such as the IP address, the user name, and so on. For more information about the client information collected by the server, see the IWMSPlayer interface.

Example Code

#include <windows.h>
#include "wmsserver.h"

// Declare variables and interfaces.
IWMSServer      *pServer;
IWMSPlayers     *pPlayers;

HRESULT         hr;

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

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