Description Retrieves the diffraction order for a specific path event.
Syntax order = PathEventDiffractOrder ( path, event )
Parameters order (Long) The diffraction order of the given event. If the event is not diffracting, the diffraction order is 0.
path As Long The identifier of the path.
event As Long The identifier of the event. Path events can be indexed forward or backwards. For example, an event ID of 0 indicates the first event along the path, 1 indexes the second event, etc. When using negative event indexing, -1 indicates the last event along the path, -2 is the second to last event, etc.
Remarks This function retrieves the diffraction order for a specific path event. If there is a problem the function sets an error and returns 0.
See Also
Examples
|