Skip to main content

GetAttributeDescription

Use this function to return the description of the specified attribute. The description is returned as a string.

Syntax:

GetAttributeDescription( "AttrClass", "AttrName" [, "LanguageCode"])

where:

  • AttrClass is the Attribute class. Select from the following:
    AttrClass Description

    SYSTEM

    Describes the entire system at the highest level. Attributes of this Attribute class specify system-wide characteristics.

    USER

    Describes the Attributes of a particular user.

    SYMBOL

    Describes the characteristics of individual symbols.

  • AttrName is the name of the attribute whose description you wish to retrieve.
  • LanguageCode is the optional language code, with a default value of EN.

Syntax example:

SET VARIABLE attrDescription = GetAttributeDescription( "SYSTEM", "ASReportingPeriod", "EN")

Was this article helpful?

We're sorry to hear that.