Guardian Procedure Calls Reference Manual (G06.25+)

DEFINEs
Guardian Procedure Calls Reference Manual—522629-013
E-2
DEFINE Attributes
•
When specified as the value of a procedure parameter that has a fixed length of
24 characters, a DEFINE name must be left-justified in the DEFINE name buffer
and padded on the right with blanks.
Uppercase and lowercase letters in a DEFINE name are equivalent. For example, the
name =MY^DEFINE is equivalent to =My^Define.
DEFINE Attributes
A set of attributes is associated with each DEFINE. One attribute that is associated
with every DEFINE is the CLASS attribute. The CLASS attribute determines which
other attributes can be associated with the DEFINE.
Each attribute has:
•
An attribute name that you cannot change.
•
A data type that determines the kind of value that you can assign to the attribute.
•
A value that you assign programmatically by a call to the DEFINESETATTR
procedure, or interactively by the TACL SET DEFINE command. Some attributes
have default values.
Attribute Data Types
When you assign a value to an attribute, you specify the value as a parameter to a
procedure call. This parameter must be declared type STRING.
The string values that you can specify for a particular DEFINE attribute is determined
by the data type of the DEFINE attribute. The available attribute data types are:
String The attribute can contain a string of from 1 to a maximum of 512 ASCII
characters, depending on the particular attribute.
Number The attribute can contain an integer consisting of from 1 to a maximum
of 18 digits, depending on the particular attribute. This integer can be
preceded by a plus or minus sign and must not contain a decimal point.
On output, the integer is left-justified with leading zeros suppressed.
Filename The attribute can contain a file name. The file name can be fully or
partially qualified. A partially qualified file name is expanded using the
default-names value that you specify to the DEFINESETATTR
procedure. On output, the file name is always fully qualified.
Subvolname The attribute can contain a subvolume name. The subvolume name
can be fully or partially qualified. A partially qualified subvolume name
is expanded using the
default-names value that you specify to the
DEFINESETATTR procedure. On output, the subvolume name is
always fully qualified, except when it is obtained from the VOLUME
attribute of a CLASS DEFAULTS DEFINE.
Keyword The attribute can contain one of a predefined set of keywords. These
keywords are specific to the particular DEFINE attribute.