Skip to main content

1E 9.x (on-premises)

Tagging.Get

Method

Get

Module

Tagging

Library

Core

Action

Indicate whether a named tag of the specified type is present and return its value if present.

Parameters

Name (string): The name of the tag whose value is to be retrieved.

Scopable (boolean; optional):

  • true - Get a Device tag (default)

  • false - Get a Freeform tag

Return values

Present (boolean): true if the tag originally exists and so has a value, false if there was no such tag.

Value (string): The tag's value if it was present, otherwise an empty string. An empty string is also a valid value.

Example

// Get the value of the "WithScanner" freeform tag
Tagging.Get(Name: "WithScanner", Scopable: false);

Platforms

  • Windows

  • Linux

  • MacOS

Notes

It is not an error if the tag does not exist.