Qicc Exit Operation structure

The Qicc Exit Operation structure contains information on the operation.

Fields

  • in operation_info_len (offset 0x00): byte [4]
  • in control_value_len (offset 0x04): int [4]
  • in handle (offset 0x08): byte [4]
  • in cloud_resource_name (offset 0x0C): char [10]
  • in reserved (offset 0x16): byte [2]
  • in cloud_service_name (offset 0x18): char [20]
  • in cloud_resource_uri (offset 0x2C): char [1024]
  • in operation (offset 0x42C): byte [4]
  • in transfer_state (offset 0x430): byte [4]
  • in transfer_error_code (offset 0x434): byte [4]
  • in exit_user_data (offset 0x438): char [52]
  • in async (offset 0x46C): byte [4]
  • in cloud_path_name (offset 0x470): Qlg_Path_Name_T
For information on the Qlg_Path_Name_T structure, see Path name format in the IBM Documentation.

Field descriptions

operation_info_len
The length of the Qicc Exit Operation structure byte stream. The value will be 1168 plus the cloud_path_name length.
control_value_len
The length of the Qicc Exit Control Value structure byte stream. The value is an integer of 4 bytes. In the byte stream, the value in hexadecimal format is 0x00000004.
handle
An ID that uniquely identifies a file transfer.
cloud_resource_name
The unique name of the cloud resource involved in the operation.
cloud_service_name
The unique name of the cloud service that provides the resource involved in the operation.
cloud_resource_uri
The Uniform Resource Identifier (URI) of the resource involved in the operation.
operation
The type of operation: 0 means a file upload, 1 means a file download. In the byte stream, the value in hexadecimal format is 0x00000000 or 0x00000001.
transfer_state
The file transfer status, with one of the following values:
  • 0: Success
  • 1: Failure
  • 2: Failure (retriable error)

In the byte stream, the value in hexadecimal format is 0x00000000, 0x00000001, or 0x00000002.

transfer_error_code
The reason for a failed transfer, with one of the following values:
  • 0000: No error
  • 0001: Warning that the downloaded file was given a default value
  • 0002: No connection to the server
  • 0003: Communication error between the client and server
  • 0004: Invalid password
  • 0005: Invalid user
  • 0006: Lost connection
  • 0007: Connection timed out
  • 0008: Ran out of storage
  • 0009: Transfer canceled
  • 0010: Maximum retires exceeded
  • 0011: Data error
  • 0012: Authority problem with the Cloud server
  • 0013: Local file could not be opened, read, or written (io error)
  • 0014: Cloud file not found
  • 0015: Local file not found
  • 0016: Internal program error

In the byte stream, an example of the value 0001 in hexadecimal format is 0x00000001.

exit_user_data
The user who called the cloud upload or download API. The information is passed to Cloud Storage Solutions by the program that called the upload or download API. This data can be used to identify a particular invocation of the API.
async
Indicates whether the operation should occur synchronously or asynchronously.
cloud_path_name
The path in the cloud that the file was uploaded to or downloaded from. The value uses the Qlg_Path_Name_T path name format. See Path name format in the IBM Documentation.