Save Storage Free Exit Program
Required Parameter Group:
| 1 | Path name pointers | Input | Char(*) |
| 2 | Return code pointer | Output | Binary(4) |
| 3 | Return value pointer | Output | Binary(4) |
| 4 | Function control block pointer | Input | Char(*) |
The Save Storage Free exit program is a user-specified program that is called by Qp0lSaveStgFree() to save a stream file object (object type *STMF). This exit program can be either a procedure or program.
When the Save Storage Free exit program is given control, it should save the object so it can be dynamically retrieved at a later time. The *STMF object is locked when the exit program is called to prevent changes to it until the storage free operation is complete. If the Save Storage Free exit program ends unsuccessfully, it must return a valid errno in the storage pointed to by the return value pointer. Qp0lSaveStgFree() then passes this errno to its caller with a minus one return code.
Storage referred to by the path name pointers or the return code pointer when the Save Storage Free exit program is called is destroyed or reused when Qp0lSaveStgFree() regains control.
Authorities and Locks
None.
Required Parameter Group
- Path names pointers
- INPUT; CHAR(*)
All of the path names to the *STMF object being storage freed. There is one path name for each link to the object. These path names are in the Qlg_Path_Name_T format and are in the UCS-2 CCSID. See Path name format for more information on this format. For information about UCS-2, see the i5/OS globalization topic collection.
Path Name Pointers Offset Type Field Dec Hex 0 0 BINARY(4) Number of path names 4 4 CHAR(12) Reserved 16 10 ARRAY(*) Array of path name pointers Array of path name pointers. Pointers to each path name that Qp0lSaveStgFree() found for the object identified by the path name on the call to Qp0lSaveStgFree(). Each path name is in the Qlg_Path_Name_T format.
Number of path names. The total number of path names that Qp0lSaveStgFree() found for the object identified by the caller of Qp0lSaveStgFree().
Reserved. A reserved field. This field must be set to binary zero.
- Return code pointer
- OUTPUT; BINARY(4)
A pointer to an indicator that is returned to indicate whether the exit program was successful or whether it failed. Valid values follow:
0 The Save Storage Free exit program was successful. -1 The Save Storage Free exit program was not successful. The Return value pointer is set to indicate the error.
- Return value pointer
- OUTPUT; BINARY(4)
A pointer to a valid errno that is returned from the exit program to identify the reason it was not successful.
- Function control block pointer
- INPUT; CHAR(*)
A pointer to the data that is passed to Qp0lSaveStgFree() on its call. Qp0lSaveStgFree() does not process the data that is referred to by this pointer, but passes this pointer as a parameter when it calls the exit program.
Related Information
- Qp0lSaveStgFree()--Save Storage Free
Exit program introduced: V4R3
[ Back to top | Backup and Recovery APIs | APIs by category ]