lsm_job_status_volume_get(3) | Libstoragemgmt C API Manual | lsm_job_status_volume_get(3) |
NAME¶
lsm_job_status_volume_get - Check on the status of a job with lsm_volume returned.
SYNOPSIS¶
int lsm_job_status_volume_get (lsm_connect *conn, const char *job_id, lsm_job_status *status, uint8_t *percent_complete, lsm_volume **vol, lsm_flag flags);
ARGUMENTS¶
- conn
- Valid connection pointer.
- job_id
- String. Job to check status on
- status
- Output pointer of lsm_job_status. Possible values are: * LSM_JOB_COMPLETE
Job complete with no error. * LSM_JOB_ERROR
Job complete with error. * LSM_JOB_INPROGRESS
Job is still in progress. - percent_complete
- Output pointer of uint8_t. Percent job complete. Domain 0..100.
- vol
- Output pointer of lsm_volume for completed operation. Returned value needs to be freed with a call to lsm_volume_record_free.
- flags
- Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
VERSION¶
1.0
DESCRIPTION¶
Check on the status of a job and returns the volume information when complete.
RETURN¶
Error code as enumerated by 'lsm_error_number'.
* LSM_ERR_OK
On success.
* LSM_ERR_INVALID_ARGUMENT
When any argument is NULL or not a valid lsm_connect pointer
or invalid flags.
* LSM_ERR_NOT_FOUND_JOB
When job not found.
lsm_job_status_volume_get | April 2023 |