Share via


IWMSServerLimits::get_PlayerInactivityTimeout

banner art

Previous Next

IWMSServerLimits::get_PlayerInactivityTimeout

The get_PlayerInactivityTimeout method retrieves the maximum length of time that a player is permitted to remain connected without receiving streamed content.

Syntax

  HRESULT get_PlayerInactivityTimeout(
  long*  pVal
);

Parameters

pVal

[out] Pointer to a long containing the permitted connection time in seconds.

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. Existing connections are controlled by the inactivity time-out specified when they connected. If the parameter is –1, there is no time-out limit. By default, the value of the parameter is 86,400 seconds (24 hours). The value zero is not valid for the pVal parameter.

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