IWMSPublishingPointLimits::get_ConnectedPlayers
The get_ConnectedPlayers method retrieves the largest number of players that can be simultaneously connected to the publishing point.
HRESULT get_ConnectedPlayers(
long* pVal
);
Arguments
pVal |
[out] Pointer to a long containing the maximum number of connected players. |
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
By default, the parameter is –1, indicating that there is no limit on the number of connected players.
Example
#include <windows.h>
#include <atlbase.h> // Includes CComVariant.
#include "wmsserver.h"
// Declare variables and interfaces.
IWMSServer *pServer;
IWMSPublishingPoints *pPubPoints;
IWMSPublishingPoint *pPubPoint;
IWMSPublishingPointLimits *pLimits;
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 a pointer to the IWMSPublishingPointLimits
// interface for the publishing point.
hr = pPubPoint->get_Limits(&pLimits);
if (FAILED(hr)) goto EXIT;
// Retrieve the limit for concurrently connected clients.
hr = pLimits->get_ConnectedPlayers(&lValue);
if (FAILED(hr)) goto EXIT;
// Release temporary COM objects.
pPubPoint->Release();
pLimits->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.