Share via

IWMSServerLimits::get_PerPlayerConnectionBandwidth

  • Article

banner art

Previous Next

IWMSServerLimits::get_PerPlayerConnectionBandwidth

The get_PerPlayerConnectionBandwidth method retrieves the maximum bandwidth permitted for a single player connection.

Syntax

  HRESULT get_PerPlayerConnectionBandwidth(
  long*  pVal
);

Parameters

pVal

[out] Pointer to a long containing the maximum bandwidth in Kbps.

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 property applies only to new connections. If the parameter is –1, there is no limit on the bandwidth. By default, the value of the parameter is –1.

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