$ent->ib()

Syntax

$ent->ib( [,$options] ) 

Description

Returns a list of lines of text, representing the Info Browser information for an entity.

Arguments

An $options string may be used to specify some arguments used to create the text. The format of the options string is "name=value" or "{field-name}name=value". Multiple options may be separated with a semicolon. Spaces are allowed and are significant between multi-word field names, whereas, case is not significant.

An option that specifies a field name is specific to that named field of the Info Browser. The available field names are exactly as they appear in the Info Browser.

When a field is nested within another field, the correct name is the two names combined. For example, in C++, the field Macros within the field Local would be specified as "Local Macros".

A field and its subfields may be disabled by specifying levels=0, or by specifying the field off, without specifying any option. For example, either of the following disables and hides the Metrics field:

{Metrics}levels=0; 
{Metrics}=off; 

Field names may be full names or short names. For example, either “c++ metrics” or “metrics” may be used as a field name.

The following option is available only without a field name.

The following options are available only with a field name. Not all options are available for all field names. The available options are the same as those displayed when you right-click on the field name in the Understand software. The defaults differ for each language and each field name.


Scientific Toolworks, Inc.
http://www.scitools.com