api_get_graph_pattern_name_by_index()

Returns the name of the pattern for the given pattern index; null if not found.

See also: api_get_graph_pattern_index_by_name(), api_get_current_window(), api_get_window_graph().

Syntax:

api_get_graph_pattern_name_by_index(graphH, ptnIndex);

where

graphH is a handle to the window graphics area, as returned from api_get_window_graph().

ptnIndex is the pattern index (integer >= 0).

Example:

decl winInst, graphH, ptnName;
winInst = api_get_current_window();
graphH = api_get_window_graph (winInst);
ptnName = api_get_graph_pattern_name_by_index (graphH, 1);

Where Used:

Graphical user interface