Skip to main content
insightsoftware Documentation insightsoftware Documentation
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

GetSymbolVirtualStatus

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

Return Value

Description

ON

The symbol is a virtual symbol.

OFF

The symbol is not a virtual symbol.

Copy

Syntax

GetSymbolVirtualStatus("dimension", "symName")        

where:

  • dimension is the name of the dimension that contains the symbol.
  • symName is the name of the symbol whose virtual status is to be retrieved.
Copy

Syntax example

Set Variable symVirtualStatus = GetSymbolVirtualStatus("ACCOUNTS", "Trial_Balance")        

Published:

GetSymbolVirtualStatus

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

Return Value

Description

ON

The symbol is a virtual symbol.

OFF

The symbol is not a virtual symbol.

Copy

Syntax

GetSymbolVirtualStatus("dimension", "symName")        

where:

  • dimension is the name of the dimension that contains the symbol.
  • symName is the name of the symbol whose virtual status is to be retrieved.
Copy

Syntax example

Set Variable symVirtualStatus = GetSymbolVirtualStatus("ACCOUNTS", "Trial_Balance")        

For an optimal Community experience, Please view on Desktop