Cascade Historian: Version 4.1
Prev |  | Next

# list

list -- finds the name of available histories.

## Syntax

    (list [pattern [offset [count]]])

## Parameters

`pattern`

  The name of one or more (using a globbing pattern) histories previously defined by the history command. When this parameter is not specified, the default is `*`, to include all histories.

`offset`

  An integer specifying a starting point in the list generated by `pattern`. When this parameter is not specified, the default is `0`, to start at the beginning of the list.

`count`

  An integer specifying an end point in the list generated by `pattern`. When this parameter is not specified, the default is the maximum number of names (corresponding to the number of the last name in the list).

## Returns

A list of the history names matching the `pattern`, in the following format:

        (list pattern history1 history2 ... )

## Description

This command finds the names of specified histories. The `offset` and `count` parameters optionally permit only reporting a portion of the list generated by `pattern`. This is useful where the history names are many and/or long, because the limited size of the message buffer (typically `4K`) could result in truncation of the list.

This command corresponds to the Cogent API function `HI_List` and the `hist_list` dynamic library function.

## Example

        [sh]$ lsend Hist
        Hist> (list p*)
        (list p* p1 p2 p3 p4 p5 p6 p7 p8 p9)
        [sh]$ lsend Hist
        Hist> (list p* 5 2)
        (list p* p6 p7)
        Hist>

Prev | Home | Next
length | Up | register

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.