BrowseTags (RT Unified) - WinCC Unified

Description

The "BrowseTags" command returns the names of the tags of the local HMI system or all HMI systems communicating via runtime collaboration.

Information on the general browse behavior of the command can be found in section Behavior of the browse commands.

If the number of hits exceeds the page size of the response, the command consists of an initial request and 1 to N Next requests:

• You define the query in the initial request.

  It provides a response that delivers the first set of hits.

• You can call the remaining hits via Next requests.

Initial request

BrowseTags <System> <Page size> --filter <Filter>

• System: Optional

  Controls from which system the tags are read.

  • Value: "*"

    All systems that communicate with each other via runtime collaboration

  • Default value: The local system

• Page size: Optional

  Controls how many tags a response returns.

  Default value: The configured page size is used. See also section ReadConfig.

• --filter <Filter>: Optional

  Restricts the command to tags whose "Name" matches the filter.

  • --filter: Command line command

  • <Filter>: The filter string

    Permitted wildcards:

    Wildcard	Description	Example
    *	Replaces 0 to more characters	Filter string: "Motor*" Tags contained in the response: "Motor" "MotorOn" "MotorOff"
    ?	Replaces 1 character	Filter string: "Motor_?" Tags contained in the response: "Motor_1" "Motor_2"

  • Default value: All tags of the system specified by SystemNames are queried.

For example:

BrowseTags * 100 --filter *Tag0* // browse for tags of all systems with filter and paging

Next request

BrowseTags --next

Response

OnSuccess

NotifyBrowseTags <System>::<Tag name> ... <System>::<Tag name>

For example:

NotifyBrowseTags HMI_RT_1::InternalTag0 HMI_RT_2::InternalTag01 HMI_RT_2::InternalTag02

OnError

ErrorBrowseTags <Error description>

For example:

ErrorBrowseTags Invalid arguments passed to browsing function.