Guardian Procedure Calls Reference Manual

key-value:key-value-len
input, input
STRING.EXT:ref:*, INT:value
is the key value (with its length in bytes) to which the file is to be positioned. In H06.28/J06.17
RVUs with specific SPRs and later RVUs, the maximum value of key-value-len for
key-sequenced files with increased limits is 2048. (For a list of the required H06.28/J06.17
SPRs, see SPR Requirements for Increased Enscribe Limits for the H06.28/J06.17 Release
(page 31).) For earlier RVUs and all other files, the maximum value of key-value-len is
255.
keyspecifier
input
INT:value
designates the key field (specified as the hexadecimal equivalent of the key identifier) to be
used as the access path for the file:
or if omitted, means use the file’s primary key as the access path.0
Predefined key specifier for an alternate-key field means use that field as the access path.keyspecifier
positioningmode
input
INT:value
indicates the type of key search to perform and the subset of records obtained.
These values are supported with the positioningmode parameter.
approximate0
generic1
exact2
If positioning-mode is omitted, 0 is used. See the KEYPOSITION[X] Procedures (Superseded
by FILE_SETKEY_ Procedure) (page 750) for a detailed description of these values.
options
input
INT:value
is a 16-bit value that specifies these options:
if 1, and if a record with exactly the key-length and key-value specified is found, the record is
skipped. If the keyspecifier indicates a non-unique alternate key, the record is skipped only if both
<0>
its alternate key and its primary key match the corresponding portions of the specified key-value (which
must be an alternate key value concatenated with a primary key value) for key-length bytes (which
must be the sum of the alternate and primary key lengths). This option is not supported for positioning by
primary key in relative or entry-sequenced files.
return records in descending key order. (The file is read in reverse.)<1>
specifies that positioning is performed to the last record in a set of records. This bit is ignored unless <1>
is also set.
<2>
If the options parameter is omitted, 0 is used.
comparelength
input
INT:value
FILE_SETKEY_ Procedure 507