Navigation: Scripting Reference Manual > Functions & Subroutines > PathDescription

 

PathDescription

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the description of a specified path.

 

Syntax

desc = PathDescription ( id )

 

Parameters

desc (String)

The description of the specified path.

 

id As Long

The identifier of the path.

 

Remarks

This function retrieves the description of a specified path. If there is a problem the function returns an empty string and does not set an error.

 

FRED must be in the user-defined path mode in order to use this command. Put FRED in this mode with the command SetUserDefinedRayPathMode True.

 

See Also

SetUserDefinedRayPathMode

Path Commands

 

Examples

Raypath Functions

 

 

 

 

 

Copyright © Photon Engineering, LLC