Skip to main content

1E SDK

Tagging.Check

Module

Tagging

Method

Check

Library

Core

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 Device tag (default)

  • false - Check a Freeform tag

Return values

Value (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

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.