IWMSServerCurrentCounters::get_ConnectionQueue
The get_ConnectionQueue method retrieves the current number of players in the queue to connect to the server.
HRESULT get_ConnectionQueue(
long* pVal
);
Arguments
pVal |
[out] Pointer to a long containing the number of queued 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. |
Example
#include <windows.h>
#include "wmsserver.h"
// Declare variables and interfaces.
IWMSServer *pServer;
IWMSServerCurrentCounters *pCurrentCounters;
HRESULT hr;
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 a list of current statistics
// for the server.
hr = pServer->get_CurrentCounters(&pCurrentCounters);
if (FAILED(hr)) goto EXIT;
// Retrieve the current number of clients waiting to connect.
hr = pCurrentCounters->get_ConnectionQueue(&lValue);
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.