IWMSServerCurrentCounters.ConnectedPlayers (Visual Basic .NET)

  • Article

banner art

Previous Next

IWMSServerCurrentCounters.ConnectedPlayers (Visual Basic .NET)

The ConnectedPlayers property retrieves the total number of players connected to the server.

Syntax

  Integer = IWMSServerCurrentCounters.ConnectedPlayers

Property Value

Integer containing the number of connected players.

Remarks

This property is read-only. 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

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

Private Sub CountConnectedPlayers()

    ' Declare variables.
    Dim Server As WMSServer
    Dim CurrentCounters As IWMSServerCurrentCounters
    Dim iValue As Integer

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

    ' Retrieve a list of current statistics
    ' for the server.
    CurrentCounters = Server.CurrentCounters

    ' Retrieve the current number of connected players.
    iValue = CurrentCounters.ConnectedPlayers

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