Skip to main content

1E 9.x (on-premises)

Tagging.Set

Module

Tagging

Method

Set

Library

Core

Action

Set (or change if already set) the named tag of the specified type to the specified value.

Parameters

Name (string): The name of the tag to set. Only alphanumeric characters are allowed.

Value (string): The value to assign to the tag; can be empty. Only alphanumeric characters are allowed (see notes).

Scopable (boolean; optional):

  • true - Set a Device tag (default)

  • false - Set a Freeform tag

Return values

Name (string): The tag's name.

Value (string): The tag's (new) value.

Example

// Set the "WithScanner" freeform tag to "WorkForce DS1630"
Tagging.Set(Name: "WithScanner", Value: "WorkForce DS1630", Scopable: false);

Platforms

  • Windows

  • Linux

  • MacOS

Notes

Set() does not allow a NAME=value pair to be set that increases the total size of the scopable tag list above 511 characters, and will return a runtime error.