hist_list

hist_list — finds the name of available histories.

Syntax

hist_list (hist_task[, pattern])
    

Parameters

hist_task

The task object corresponding to the Cascade Historian. See locate_task in the Gamma manual.

pattern

The name of one or more (using a globbing pattern) histories to be acted upon. When this parameter is not specified, the default is *, to include all histories.

Returns

A list of history names matching the specified pattern, if successful. Otherwise returns nil and sets _last_error_ to the error string returned by the Cascade Historian.

Description

This function generates a list of the histories available.

This function corresponds to the list command, and the Cogent C API function HI_List.