Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


New_in
Version8.1.21


Panel
titleDescription

Returns a list of roster names.

Panel
titleSyntax

system.roster.getRosterNames()

  • Parameters

None

  • Returns

List[String] - List of rosters on the Gateway.

  • Scope

Gateway, Perspective Session

Custompanel
titleCode Example
Code Block
languagepy
titleCode Snippet
# This example gets a list of rosters from the Gateway when a Button is pressed and prints the list to the browser console.

roster = system.roster.getRosterNames()
system.perspective.print(roster)
Panel
titleKeywords

system roster getRosterNames, roster.getRosterNames