Enscribe Programmer's Guide

Table 4 File-System Procedures (continued)
DescriptionProcedure
Returns the record indicated by the current key value;
FILE_READUPDATE64_ is used to randomly read an open file.
FILE_READUPDATE64_
Is the same as FILE_READUPDATE64_, but it locks the record before reading
it.
FILE_READUPDATELOCK64_
Changes the name of an open file. If the file is temporary, causes the file
to be made permanent. Supersedes RENAME.
FILE_RENAME_
Sets position by primary or by alternate key within key-sequenced,
entry-sequenced, relative, and queue files; defines a subset of the file for
FILE_RESTORE_POSITION_
FILE_SAVEPOSITION_ FILE_SETKEY_
subsequent access by setting the current position, access path, and
positioning mode. This procedure expects the primary keys for relative
and entry-sequenced files to be 8 bytes long. Supersedes KEYPOSITION.
Sets device-dependent functions for an open file.FILE_SETMODENOWAIT64_
Sets position by primary key within an entry-sequenced or relative file;
defines a subset of the file for subsequent access by setting the current
FILE_SETPOSITION_
position, access path, and positioning mode; also can specify new current
position within an unstructured file. Procedure accepts an 8-byte record
specifier so it can work with format 2 files. Supersedes POSITION.
Unlocks an open disk file currently locked by the caller; unlocks any records
in the file that are currently locked by the caller.
FILE_UNLOCKFILE64_
Unlocks a record currently locked by the caller. If generic locking is
enabled, calls to FILE_UNLOCKREC64_ are ignored.
FILE_UNLOCKREC64_
Inserts (adds) a new record into an open disk file location positioned by
the last call to READ[X], FILE_READ64_, READUPDATE[X] or
FILE_READUPDATE64_.
FILE_WRITE64_
Replaces (updates) or deletes data in the record indicated by the current
key value of an open file.
FILE_WRITEUPDATE64_
Is the same as FILE_WRITEUPDATE64_, but unlocks the record after its
contents are updated or deleted.
FILE_WRITEUPDATEUNLOCK64_
Helps determine whether a failed call should be retried.FILEERROR
Returns the next name in a set of named entities. The set is defined in a
call to FILENAME_FINDSTART_. Supersedes GETDEVNAME and
NEXTFILENAME.
FILENAME_FINDNEXT_
Returns the next name in a set of named entities. The set is defined in a
call to FILENAME_FINDSTART_. Supersedes GETDEVNAME and
NEXTFILENAME.
FILENAME_FINDNEXT64_
Sets up a search of named entities.FILENAME_FINDSTART_
Collapses an internal file identifier to external form.FNAMECOLLAPSE
Compares two internal file identifiers to determine whether they refer to
the same file or device.
FNAMECOMPARE
Expands an external file identifier to internal form.FNAMEEXPAND
Sets position by primary key within a key-sequenced or queue file or by
alternate key within key-sequenced, entry-sequenced, and relative files;
KEYPOSITION
defines a subset of the file for subsequent access by setting the current
position, access path, and positioning mode. This procedure expects the
primary keys for relative and entry sequenced files to be 4 bytes long.
Locks an open disk file, making it inaccessible to other accessors.LOCKFILE
40 System Procedures