get_default_depth

Context: depth

Synopsis

Retrieves the default depth of the frame.

Syntax

get_default_depth([id])

Description

id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to specify the frame.

Each object has a default depth preference value which may be set in the ChIPS resource file or by calling the set_preference function. The value of the preference may be set to "default" or a positive integer value. If the value is "default", then the default frame depth is used.

The get_default_depth command retrieves the default depth value of the specified frame.

The command can only operate on a single object. An error is returned if currency is set to "all".

For general information on depth, refer to "ahelp depthcontrol".

Example 1

chips> get_default_depth()

Retrieve the default depth from the current frame.

Example 2

chips> get_default_depth("frm2")

Retrieve the default depth value from "frm2".

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.