Skip to main content

GetSymbolSortOption

Use this function to return the sort option of the specified symbol. The sort option is returned as a string. Review the following table for a summary of possible return values and their corresponding status.

Return Value Description

ASCENDING

The symbol sorts the child symbols in ascending order.

DESCENDING

The symbol sorts the child symbols in descending order.

MANUAL

The symbol sorts the child symbols manually as specified by the symbol priorities.

Syntax:

GetSymbolSortOption("dimension", "symName")

where:

  • dimension is the name of the dimension that contains the symbol.
  • symName is the name of the symbol whose sort option is to be retrieved.

Syntax example:

Set Variable symSortOption = GetSymbolSortOption("ACCOUNTS", "Trial_Balance")

Was this article helpful?

We're sorry to hear that.