IWMSServerCurrentCounters::get_ConnectionRate

banner art

Previous Next

IWMSServerCurrentCounters::get_ConnectionRate

The get_ConnectionRate method retrieves the number of players connecting per second.

Syntax

  HRESULT get_ConnectionRate(
  long*  pVal
);

Parameters

pVal

[out] Pointer to a long containing the connection rate.

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

The server uses a 1-second interval to calculate the rate. To calculate a more current value, use the IWMSServerTotalCounters::get_ConnectedPlayers method.

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