Navigation: Scripting Reference Manual > Functions & Subroutines > PathFind

 

PathFind

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the identifier of the path with a specific name.

 

Syntax

id = PathFind ( pname )

 

Parameters

id (Long)

The identifier of the path, if found.

 

pname As String

The name of the path.

 

Remarks

This function retrieves the identifier of the path with a specific name. If there is a problem, or there is no path with the specified name, the function does not set an error and returns -1.

 

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