GetPathCtrlHistory

int GetPathCtrlHistory (int panel, int control, char ***items, int *numItems);

Purpose

Gets the items in the path control history.

Parameters

Input
Name Type Description
panel integer The handle of the panel for the path control.
control integer The ID of the path control.
Output
Name Type Description
items char *** The items in the path control history. Pass the address of a char ** variable to get an array of strings containing the history items. The numItems output parameter indicates the number of elements in this array. You must dispose this output array of strings as follows:


char ** items = 0;
int i, numItems;

/* Get the history */
GetPathCtrlHistory (panel, control, &items, &numItems);

/* Print and dispose the items */
puts ("Items in path control history:");
for (i = 0; i < numItems; ++i)
{
    puts (items[i]);
    free (items[i]);
}

/* Dispose the items array */
free (items);

numItems integer * The number of items in the path control history. Pass the address of an integer variable. This value indicates the number of elements in the items output parameter array.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred. Call the GetGeneralErrorString toolbox function to get a descriptive error message.