Skip to main content

1E 8.1 (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. See Tags page for guidance using tags. Device tags are also known as Coverage or Scopable tags. Software tags are not managed using Tagging methods. The following methods existing in the Agent Tagging module: Tagging.Check — Tests the existence of a named tag of a specified type, optionally with the specified value. Tagging.Clear — Delete all tags of the specified type. Tagging.Count — Get the quantity of tags of the specified type. Tagging.Delete — Delete the named tag of the specified type, and indicate if it originally existed. Tagging.Get — Indicate whether a named tag of the specified type is present and return its value if present. Tagging.GetAll — Fetch the tag list (containing all tags) of the specified type. Tagging.Set — Set (or change if already set) the named tag of the specified type to the specified value.

In this section: