Contents

Method

Get

ModuleTagging
LibraryCore
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 Coverage 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
  • Solaris Intel
  • Solaris Sparc
  • Android
Notes

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

See Tags page for guidance using tags.

The following methods existing in the Agent Tagging module:

  • Page:
    Tagging.Check — Tests the existence of a named tag of a specified type, optionally with the specified value.
  • Page:
    Tagging.Clear — Delete all tags of the specified type.
  • Page:
    Tagging.Count — Get the quantity of tags of the specified type.
  • Page:
    Tagging.Delete — Delete the named tag of the specified type, and indicate if it originally existed.
  • Page:
    Tagging.Get — Indicate whether a named tag of the specified type is present and return its value if present.
  • Page:
    Tagging.GetAll — Fetch the tag list (containing all tags) of the specified type.
  • Page:
    Tagging.Set — Set (or change if already set) the named tag of the specified type to the specified value.