Move Stream File (QHFMOVSF) API


  Required Parameter Group:

1 Source file path name Input Char(*)
2 Source file path name length Input Binary(4)
3 Target file path name Input Char(*)
4 Target file path name length Input Binary(4)
5 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Move Stream File (QHFMOVSF) API moves a single stream file from one directory to another and optionally changes the file's name. The file's attributes are not changed.

The QHFMOVSF API only moves stream files to a different path. To rename files within a path, see Rename Stream File (QHFRNMSF) API.


Authorities and Locks

None.


Required Parameter Group

Source file path name
INPUT; CHAR(*)

The path name of the file being moved. The file name is the last element of the path name.

The source file must be accessible. You cannot move a file that is already in use by another job.

Source file path name length
INPUT; BINARY(4)

The length of the source file path name, in bytes.

Target file path name
INPUT; CHAR(*)

The path name designating the new location and, optionally, the new name of the file being moved.

The target file cannot already exist. It must reside in a different path from the source file. The file name can be the same as or different from the source file name.

Target file path name length
INPUT; BINARY(4)

The length of the target file path name, in bytes.

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
CPF1F01 E Directory name not valid.
CPF1F02 E Directory not found.
CPF1F03 E New directory name same as old directory name.
CPF1F06 E Directory in use.
CPF1F07 E Authority not sufficient to access directory.
CPF1F08 E Damaged directory.
CPF1F2A E Number of open files exceeds limit.
CPF1F2E E Range of bytes in file in use.
CPF1F21 E File name not valid.
CPF1F22 E File not found.
CPF1F24 E File name already exists.
CPF1F26 E File in use.
CPF1F27 E Authority not sufficient to access file.
CPF1F28 E Damaged file.
CPF1F29 E Use of reserved file name not allowed.
CPF1F34 E Attempted write operation beyond file size limit.
CPF1F35 E Read file operation failed.
CPF1F36 E Write file operation failed.
CPF1F41 E Severe error occurred while addressing parameter list.
CPF1F42 E Attribute information table not valid.
CPF1F43 E Attribute name not valid.
CPF1F44 E Attribute value is not valid.
CPF1F46 E Use of reserved attribute name not allowed.
CPF1F48 E Path name not valid.
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.
CPF1F75 E Error occurred during start-job-session function.
CPF1F81 E API specific error occurred.
CPF1F82 E Function not supported.
CPF1F83 E File system name &1 not found.
CPF1F84 E Operation across file systems not allowed.
CPF1F85 E Not authorized to file system amp;1.
CPF1F87 E Missing or damaged exit program &2.
CPF1F97 E File system &1 in use.
CPF3C90 E Literal value cannot be changed.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V2R1
Top | Hierarchical File System APIs | APIs by category