Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (F)
Guardian Procedure Calls Reference Manual—522629-013
5-143
FILE_SETKEY_ Procedure
Parameters
error
INT:value
is a file-system error code that gives the status of the operation.
filenum input
INT:value
is the number that identifies an open-structured disk file.
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.
keyspecifier input
INT:value
designates the key field to be used as the access path for the file:
keyspecifier 0, or if omitted, means use the file’s primary key as the
access path.
Predefined key specifier for an alternate-key field means use
that field as the access path.
positioningmode input
INT:value
indicates the type of key search to perform and the subset of records obtained.
The following values are supported with the
positioningmode parameter.
0 approximate
1 generic
2 exact
If
positioning-mode is omitted, 0 is used. See the KEYPOSITION[X]
Procedures (Superseded by FILE_SETKEY_ Procedure) for a detailed description
of these values.
options input
INT:value
is a 16-bit value that specifies the following options:
<0> if 1, and if a record with exactly the key-length and key-value
specified is found, the record is skipped. If the
keyspecifier