Move Folder to ASP (QHSMMOVF) API

The Move Folder to ASP (QHSMMOVF) API moves a root folder and its contents from its existing auxiliary storage pool (ASP) to the specified target ASP through a save and restore process. The API, however, will retain private authorities to the objects that would normally be lost with a save and restore operation.

Restrictions

The Move Folder to ASP (QHSMMOVF) API has the following restrictions:

• The folder must be a root folder and will be moved as such.
• The folder and its contents must not be in use by other jobs.
• Folders that were restored using the Restore Licensed Program (RSTLICPGM) should not be moved.
• After the root folder has been moved, the following parameters are changed:
  • The date last used will be set to blank.
  • The change date and time will be set to the current date and time.
  • The days used count will be set to zero.
  • The days used count reset will be set to blank.
  • The save date/time and restore date/time will be updated.
• The target ASP must have enough space for the folder and its objects in order for the API to perform the move action.
• The target ASP must be either the system ASP, a library-type ASP, or an empty ASP.
• The user must be enrolled in the system distribution directory.
• Access codes are the responsibility of the user and will be lost.
• A root folder that contains documents checked out or saved with STG(*FREE) will not be moved.
• A root folder that contains more than 99 subfolders will not be moved.

Authorities and Locks

For detailed information about locks that are applied to objects during save operations, see the Backing up your system topic collection.

To prevent access to other jobs, the folder is renamed to QHSMFLR.xxx, where xxx is a numeric increment to allow multiple concurrent move operations.

The user profile must have *OBJALTER authority to the folder and its objects if it does not have *ALLOBJ authority.

See Authority required for objects used by commands in the Security reference topic collection for detailed information about object authorities required when you save objects.

Required Parameter Group

Folder name

INPUT; CHAR(12)

The name of the folder to be moved to the specified auxiliary storage pool (ASP).

Target auxiliary storage pool (ASP)

INPUT; BINARY(4)

The number of the auxiliary storage pool (ASP) to which the folder is to be moved. You can use one of the following values for the ASP number:

1-16	The number that was assigned to the ASP at creation time. ASP 1 is the system ASP. This ASP must be different from the ASP where the folder exists.

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
CPF2115 E	Object &1 in &2 type *&3 damaged.
CPF3C90 E	Literal value cannot be changed.
CPF8A00 E	All CPF8Axx messages could be signaled. xx is from 01 to FF.
CPF9000 E	All CPF90xx messages could be signaled. xx is from 01 to FF.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.
CPFB78B E	Errors encountered while moving or migrating folder &1.
CPFB781 E	Not authorized to folder &1.
CPFB783 E	Folder &1 cannot be moved or migrated into an object-based ASP &2.
CPFB784 E	Target ASP &1 is not valid for the move or migrate operation.
CPFB786 E	Insufficient disk capacity in ASP &1 for specified objects.
CPFB79E E	Auxiliary storage pool &1 does not exist.
CPFB790 E	Move or migrate of folder &1 failed.
CPFB799 E	Unexpected condition with &1 API. Reason & 6.

---

API introduced: V4R3

---

[ Back to top | Object APIs | APIs by category ]