DHFS gate, READ_HFS_FILE function

The READ_HFS_FILE function is used to read an entire z/OS® UNIX file into a user-specified buffer.

Input Parameters

CONTENT
A buffer into which the file is to be read.
PATHNAME
The path to the file.
CONVERT_NEWLINE
Optional Parameter
Specifies the character to which all EBCDIC newline characters ('15'x) are converted. It is typically used before converting the file to ASCII, where a newline character is not valid.

Output Parameters

REASON
The values for the parameter are:
  • ABEND
  • FILE_TOO_LARGE
  • LOOP
  • NOT_FOUND
  • NOTAUTH
  • OPEN_FAILED
  • READ_ERROR
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
LAST_MODIFIED_ABSTIME
Optional Parameter
The date and time the file was last modified, expressed in CICS ABSTIME format.
SIZE
Optional Parameter
The size of the file in bytes.
TYPE
Optional Parameter
Indicates if the PATHNAME specifies a file or a directory.
Values for the parameter are:
  • DIRECTORY
  • FILE
USS_RESPONSE
Optional Parameter
The response from UNIX System Services.


dfhs3_DHFSread_hfs_file.html | Timestamp icon Last updated: Monday, 5 June 2017