Attribute Retrieval Feature

<< Click to Display Table of Contents >>

Navigation:  Drawing Environment > Detailed command descriptions >

Attribute Retrieval Feature

Previous pageReturn to chapter overviewNext page

The Attribute Retrieval Feature is primarily aimed at scripting applications. The purpose of the feature is to retrieve values from arbitrary attributes of arbitrary blocks.

 

The command is called:

 

CAELGETATTRIBUTEVALUE

 

Two parameters are used:

 

The first one is the block name.

The second one is the attribute name.

 

The result is placed in a lisp variable called sRetAttVal. If the block/attribute combination is not found, the returned value is NOT_FOUND.

 

Example:

 

You would like to retrieve the sheet number and use it for some important operation.

 

The sheet number is located in a block called BLATT in an attribute also called BLATT.

 

The following command in a script sequence would place the sheet number in the sRetAttVal lisp variable:

 

CAELGETATTRIBUTEVALUE;
BLATT;
BLATT;

 

Semi-colon (“;”) has been used to symbolise the <RETURN> key in the example above, as it is in script sequences in general.

 

To check the content of the return variable, you can simply type the following at the command prompt:

 

!sRetAttVal

 

The result is displayed in the command line.

 

Using lisp expressions, you can then process this information further, for example for use in script sequences.