IWMSServerCurrentCounters::get_ConnectedPlayers

  • Article

banner art

Previous Next

IWMSServerCurrentCounters::get_ConnectedPlayers

The get_ConnectedPlayers method retrieves the total number of players connected to the server.

Syntax

  HRESULT get_ConnectedPlayers(
  long*  pVal
);

Parameters

pVal

[out] Pointer to a long containing the number of connected players.

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 count of players represents each client's session, not its physical connection to the server. When a client is disconnected from the server unexpectedly, the client will attempt to reconnect to the server. When this occurs, the server will not decrement this counter until the server times out a player's session.

Example Code

  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