| 1 | Session handle | Output | Char(8) |
| 2 | Error code | I/O | Char(*) |
The Start Disk Management Session (QYASSDMS) API activates an exclusive session to the system. Only one session can be active at any time.
On successful completion of this API, a handle is returned. This handle is used on subsequent calls to the following APIs:
After you successfully start a disk management session, the session remains active until either the session is explicitly ended by using the End Disk Management Session (QYASEDMS) API or at least five minutes of no session activity has occurred and another request to either start a disk management session or to start DST has been made. If this second event occurs, the original session is ended automatically, its session handle is invalidated, and a new session is started for the requesting caller; also, a new session handle is generated.
Each time a subsequent disk management API call is made with either the QYASSDMO or QYASRDMS APIs using the handle returned from this API, a new timing cycle begins. This timeout cycle restarts only after an operation (QYASSDMO) has completed or a status check (QYASRDMS) has been requested using the associated session handle. The timeout cycle is suspended while an action is in progress that was called using the QYASSDMO API.
To use this API, you must have *SERVICE special authority or must be authorized to the Service Disk Units function of the IBM® i operating system through System i™ Navigator's Application Administration support. The Change Function Usage Information (QSYCHFUI) API, with a function ID of QIBM_QYAS_SERVICE_DISKMGMT, also can be used to change the list of users who are allowed to work with disk units.
An 8-byte field containing a unique ID that will be used in subsequent disk management API calls for the duration of the active session. The session handle contains arbitrary binary data and should not be interpreted as character data.
The structure in which to return error information. For the format of the structure, see Error code parameter.
| Message ID | Error Message Text |
|---|---|
| CPF2277 E | User &1 not allowed to use function &2. |
| CPFBA21 E | A session is active. |
| CPFBA22 E | A save storage operation is in progress. |
| CPFBA25 E | A general disk management error has occurred. |
| CPFBA48 E | Operation failed with unrecognized return code, &1. |
| CPFBA53 E | Unexpected authority validation error has occurred. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3CF1 E | Error code parameter not valid. |