Programmer Guide/Command Reference/ATTRIBUTES: Difference between revisions

Revision as of 19:07, 11 March 2011

The ATTRIBUTES command retrieves a blank-separated list of attributes of a shell item, or of variables available in a given context.

#list := ATTRIBUTES item|MACRO|SHELL|GLOBAL

returns the blank-separated list of all available attributes for the supplied shell item item or a list of variables available:

#table := new table *
#list := ATTRIBUTES $#table
um 'The item attributes available for a table item are: $#list'
delete /Var #list

See also the example script relection.sts.

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:{{SUBPAGENAME}}}}
-==ATTRIBUTES==
+== ATTRIBUTES ==
-<code>#list := ATTRIBUTES item|MACRO|SHELL|GLOBAL</code>
+=== Overview ===
-Returns a blank separated list of available attributes for the specified shell item, or a list of variables available in the current macro, shell or globally.
+The <code>ATTRIBUTES</code> command retrieves a blank-separated list of attributes of a shell item, or of variables available in a given context.
-Example:
+=== Usage ===
-<code>#table := new table *
+;<code>#list := ATTRIBUTES item|MACRO|SHELL|GLOBAL</code>: returns the blank-separated list of all available attributes for the supplied shell item <code>item</code> or a list of variables available:
-#list := ATTRIBUTES $#table
+:* in the current macro, if <code>ATTRIBUTES MACRO</code> is used;
-um 'The item attributes available for a table item are: $#list'
+:* in the current shell, if <code>ATTRIBUTES SHELL</code> is used;
-delete /Var #list</code>
+:* globally, if <code>ATTRIBUTES GLOBAÖ</code> is used.
+=== Example ===
+ #table := new table *
+ #list := ATTRIBUTES $#table
+ um 'The item attributes available for a table item are: $#list'
+ delete /Var #list
 See also the example script <code>relection.sts</code>.
+<!-- C.G. 11.3.2011 -->