Version: 8
restore

Contents

Method

Delete

ModuleTagging
LibraryCore
Action


Delete the named tag of the specified type, and indicate if it originally existed.

Parameters

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

Scopable (boolean; optional):

  • true - Delete a Coverage tag (default)
  • false - Delete a Freeform tag
Return values

Name (string): The tag's name.

Present (boolean): true if the tag originally existed (and so was deleted), false if there was no such tag.

Example
// Delete the "WithScanner" freeform tag 
Tagging.Delete(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.