Guardian Procedure Calls Reference Manual

Table 15 FILE_ALTERLIST_ Item Codes (continued)
DescriptionSize (Bytes)Code
Alternate-file names. A string array containing the concatenated names of the alternate-key
files. Since each name occupies exactly the number of characters specified in the corresponding
*104
entry of item 103, the total length of this item is the sum of the values in item 103. The names
can be fully or partially qualified. Partially qualified names are resolved using the contents of
the =_DEFAULTS DEFINE. The volume portion of an alternate-file name can be a full eight
characters, including the dollar sign, only if the system (specified or implied) is the same as
the system on which the primary file is being created.
Alternate-key descriptors (32-bit). An array of 14-byte key descriptor entries, one for each
alternate key. Each entry contains this structure:
106
INT key-specifier;
INT key-len;
INT (32) key-offset;
INT key-filenum;
INT null-value;
INT attributes;
The attributes parameter has these fields:
Do not index when null.<0>
Unique.<1>
Do not update.<2>
Insertion order duplicates.<3>
Reserved. Must be zero.<4:15>
These fields have the same semantics as the corresponding fields of item 101.
The length of this item in bytes is 14 times item 100. This is an alternate form for item 101,
and if used, must immediately follow item 100 in place of item 101.
Alternate-file relative name-length array. An array of INT byte counts, each giving the length
of the corresponding alternate-file name in item 109. The length of this item is two times item
*108
102. This is an alternate form for item 103, and if used, must immediately follow item 102 in
place of item 103.
Alternate-file relative names. Concatenated names of the alternate-key files. Each name occupies
the number of characters specified in the corresponding entry of item 108; total length of this
*109
parameter is the sum of the values in item 108. The names must be fully qualified, except the
system name can be missing. If the system name is missing, the system of the primary file will
be used. Also, an implicit system is not recorded explicitly with the file, and so it remains
relative to the primary file if copied to another system. The volume portion of the name can be
eight characters (including the "$") only if the specified or implied system is the same as the
system where the primary partition is created. This is an alternate form for item 104 and, if
used, must immediately follow item 108.
Partition modification time. For disk objects other than SQL shorthand views, the Julian GMT
timestamp indicating the last modification time of the partition named in the open operation
8140
(when returned by FILE_GETINFOLIST_ ) or of the partition named in this call (when returned
by FILE_GETINFOLISTBYNAME_).
Considerations
• The specified file cannot be open when FILE_ALTERLIST_ is called.
• The caller of FILE_ALTERLIST_ must have read and write access to the specified file.
• If a file attribute already has the value supplied to FILE_ALTERLIST_, no error is returned.
• Except as noted in Table 15, the alterations are not made to alternate-key files, but they are
made to secondary partitions unless partonly is 1.
FILE_ALTERLIST_ Procedure 351