Contents

Method

Check

ModuleTagging
LibraryCore
Action

Tests the existence of a named tag of a specified type, optionally with the specified value.

Parameters

Name (string): The name of the tag to investigate.

Value (string; optional): The value of the tag if we want to test whether the tag has a particular value.

Scopable (boolean; optional):

  • true - Check a Coverage tag (default)
  • false - Check a Freeform tag
Return valuesValue (string): The tag's value if the tag exists (and has the specified value), else nothing.
Example
// Get the value of the freeform tag named "WithScanner", if it exists
Tagging.Check(Name: "WithScanner", Scopable: false);
// Find instances of freeform tag "WithScanner" that are set to "WorkForce DS1630":
Tagging.Check(Name: "WithScanner", Value: "WorkForce DS1630", Scopable: false);
Platforms
  • Windows
  • Linux
  • MacOS
  • Solaris Intel
  • Solaris Sparc
  • Android
Notes

This method can be used with the agent language's evaluate statement to abandon processing if the tag is not present, or does not have the specified value.

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.