STRUCTNAME Function

Returns the name of a structure if the input variable name is of type structure.

Usage

result = structname(s)

Input Parameters

s—A PV-WAVE variable.

Returned value

The returned value of this function is:

A string containing the name of the structure in all uppercase letters associated with input parameter s, if s is a structure.

An empty string if s is any variable type other than structure.

Keywords

None.

Discussion

If s is a variable associated with an unnamed structure, STRUCTNAME returns the internal PV-WAVE variable's name. This string starts with the '$' character. The two unnamed structures can be compared to determine if they are of the same structure type. STRUCTINFO can be used to determine if two structures have been identically defined (named or unnamed).

If s is a variable associated with a named structure, STRUCTNAME returns the name of the structure.

Example

a = {, x:0, y:0}

b = {myname, z:1}

; Print the PV-WAVE internal variable name starting with '$'

PRINT, STRUCTNAME(a) 

; PV-WAVE prints: $1

PRINT, STRUCTNAME(b)

; PV-WAVE prints: MYNAME

INFO, STRUCTNAME(0) 

; PV-WAVE prints: <Expression>    STRING    = ''