Force Buffered Data (QHFFRCSF) API


  Required Parameter Group:

1 Files to force Input Char(16)
2 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Force Buffered Data (QHFFRCSF) API synchronously forces buffered data and directory entry information out of main storage and into nonvolatile storage for either a specific file or all files opened by a job. (Nonvolatile storage is any storage area whose contents are not lost when power is cut off or when the system is loaded.) Forcing buffered data is similar to closing a file because the data is forced. However, after a force operation, the file remains open, and forcing has no effect on locks and read/write positions.


Authorities and Locks

None.


Required Parameter Group

Files to force
INPUT; CHAR(16)

The files whose data is being forced. Valid values are:

Open file handle Forces the single file that was assigned this handle when opened with the Open Stream File (QHFOPNSF) API.
Hexadecimal zeros Forces all files opened by the job.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Error Messages

Message ID Error Message Text
CPF1F2B E Write operation not allowed to file opened for read only.
CPF1F2E E Range of bytes in file in use.
CPF1F25 E File handle not valid.
CPF1F28 E Damaged file.
CPF1F41 E Severe error occurred while addressing parameter list.
CPF1F52 E Error code not valid.
CPF1F61 E No free space available on media.
CPF1F62 E Requested function failed.
CPF1F63 E Media is write protected.
CPF1F66 E Storage needed exceeds maximum limit for user profile &1.
CPF1F71 E Exception specific to file system occurred.
CPF1F72 E Internal file system error occurred.
CPF1F73 E Not authorized to use command.
CPF1F74 E Not authorized to object.
CPF1F82 E Function not supported.
CPF1F86 E Force all files did not complete successfully.
CPF1F87 E Missing or damaged exit program &2.
CPF3C90 E Literal value cannot be changed.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V2R1

[ Back to top | Hierarchical File System APIs | APIs by category ]