IWMSServerLimits.ConnectedPlayers (Visual Basic .NET)

  • Article

banner art

Previous Next

IWMSServerLimits.ConnectedPlayers (Visual Basic .NET)

The ConnectedPlayers property specifies and retrieves the largest number of players that can be simultaneously connected to the server.

Syntax

  IWMSServerLimits
  .ConnectedPlayers = Integer
Integer = IWMSServerLimits.ConnectedPlayers

Property Value

Integer containing the number of player connections permitted. If the value of the property is –1, there is no limit on the number of permitted player connections.

If this property fails, it returns an error number.

Number Description
0x80070057 Integer is an invalid argument.

Remarks

A player can bypass this limit by identifying itself as a distribution server. Therefore, it is recommended that you also use the IWMSServerLimits.OutgoingDistributionConnections property to specify the maximum number of distribution servers that can connect. A player can identify itself as a distribution server by changing its user agent. For more information about user agents, see Identifying a Cache Proxy Server.

Example Code

Imports Microsoft.WindowsMediaServices.Interop
Imports System.Runtime.InteropServices

Private Sub GetSetPlayerLimit()

    ' Declare variables.
    Dim Server As WMSServer
    Dim Limits As IWMSServerLimits
    Dim iValue As Integer

Try
    ' Create the WMSServer object.
    Server = New WMSServer()

    ' Retrieve the IWMSServerLimits object for the server.
    Limits = Server.Limits

    ' Retrieve the limit for concurrently connected clients.
    iValue = Limits.ConnectedPlayers

    ' Set the limit for concurrently connected clients.
    Limits.ConnectedPlayers = 20

Catch excCom As COMException
    ' TODO: Handle COM exceptions.
Catch exc As Exception
    ' TODO: Handle errors.
Finally
    ' TODO: Clean-up code goes here.
End Try

End Sub

Requirements

Reference: Add a reference to Microsoft.WindowsMediaServices.

Namespace: Microsoft.WindowsMediaServices.Interop.

Assembly: Microsoft.WindowsMediaServices.dll.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also

Previous Next