Using KSAM/XL and KSAM 64 (32650-90886)

144 Chapter9
KSAM Intrinsics
FRENAME
FRENAME
Renames an open disk file (and its lockword, if applicable). The file being renamed must be
either:
• A new file.
• An old file (permanent or temporary), opened for exclusive access with the
exclusive
option of the HPFOPEN/FOPEN intrinsics, and with security provisions allowing write
access.
Syntax
I16V CA
FRENAME(
filenum,formaldesig );
Parameters
filenum 16-bit signed integer by value (required)
Passes the file number of the file to be renamed.
formaldesig character array (required)
Passes the new name of the file. The maximum number of characters
allowed in the string is 36. The ASCII string contained in
formaldesig
must begin with a letter and can contain up to eight alphanumeric
characters for each of the
filename, lockword, group , and account
fields. The string must end with a nonalphanumeric character, including a
blank, but not a slash (/) or a period (.). The home volume set of
formaldesig must be the same as the file being renamed. Volume sets
cannot be spanned when renaming files. The format of
formaldesig is:
filename/lockword.group.account
where:
filename Is the new file name for the file. (Required in
formaldesig .)
lockword Is a lockword for the new file name. (Optional portion of
formaldesig .) To keep or add a lockword to the file, the
lockword must be entered in the ASCII string. If this
part of
formaldesig is not specified, the new file name
has no lockword associated with it.
group Is the group where the file is to reside. (Optional portion of
formaldesig .) If a group is not specified, the file resides
in the group it was assigned before the FRENAME intrinsic
call.
account Is the account name where the file is to reside. (Optional
portion of
formaldesig .) If renaming a new or temporary