Description This function returns the power units string that is stored in the ARN being queried. The power units that is stored in the ARN header at the time of creation is related to the type of calculation that is performed. If all source power units were known at the time the rays were created, then the power units will correspond to the calculation (i.e. Watts, Lumens, etc.). If any source power units were unspecified at the time of ray creation, an empty string is returned by the ARNGetPowerUnits function.
Syntax pUnits = ARNGetPowerUnits( arnNode )
Parameters pUnits As String Returned string containing the power ARN power units.
arnNode As Long Node number of the ARN whose power units are being queried.
Example The following example queries an ARN for its power units and prints the result to the output window.
Sub Main
Dim arnNode As Long arnNode = ARNFindName( "Irradiance 1" )
Dim pUnits As String pUnits = ARNGetPowerUnits( arnNode )
Print "ARN power units are: " & pUnits
End Sub
See Also
|