Description Short description of what this does.
Syntax scatter = PathEventIsScatter ( path, event )
Parameters scatter (Boolean) The scatter state of the event. True if the event is scatter, False otherwise.
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 identifies if a path event is a scatter event. If there is a problem the function sets an error and returns False.
See Also
Examples
|