isCOBOL Evolve : Appendices : Library Routines : S$IO : S-OPEN-FUNCTION
S-OPEN-FUNCTION
This function opens an existing sequential file. If it is successful, the value in RETURN-CODE should be moved to a data item that is USAGE HANDLE. This data item is passed as the open file handle to the other file handling functions.
If it fails, RETURN-CODE is set to ZERO.
This function only opens already existing files. If the file does not exist, the function fails, even when opening for output.
Syntax:
 SET S-OPEN-FUNCTION TO TRUE
 
 CALL "S$IO" USING SIO-FUNCTION
                   name
                   mode 
                   recSize
                   type
                  [blocking]
                  [padding ]
                  [pipeName]
            GIVING returnCode
Parameters:
name
the name of the file to open.
mode
one of the following values (defined in isfilesys.def):
 
Finput
Foutput
Fio
Fextend
Open for input only.
Open for output only.
Open for input and output.
Same as Foutput.
mode may also have one of the following flags (defined in isfilesys.def) added to it to indicate file locking options:
Fread_lock
Fwrite_lock
Fmass_update
Locks file against other updaters.
Locks file against all others.
Same as Fwrite_lock.
recSize
the maximum record size.
type
one of the following values (defined in isfilesys.def):
 
S-FIXED
S-VAR-COUNT
S-LINE
fixed record binary sequential file
variable record length binary sequential file
line sequential file
blocking
size of a block, in bytes. This parameter is optional. If omitted or set to 0, a block is the size of a record.
padding
value of the pad character for filling short blocks. This parameter is optional. If omitted or set to 0, any short blocks are padded with 0x00.
pipeName
name of the pipe to open instead of a file. This parameter is optional.
Return code:
returnCode can be any signed numeric data item and provides additional information:
>0
File handle.
0
Operation failed.