get_units_enum

The get_units_enum function retrieves the enum value for units, given the string name of the units.

 

Syntax
ENUM get_units_enum(
    PCSTRINGZ  unitname
    );

 

Members
Parameters Description
unitname Specifies the string name of the units.

Return Values

The function returns the ENUM value for the units, or UNITS_UNKNOWN (-1) if the string name is not found.

 

Remarks

You can find a list of all the accepted strings from the page on Simulation Variable Units.

 

See Also