HixlCSClientQueryCompleteStatus

Function Description

Queries the completion status of an asynchronous batch task.

Prototype

HixlStatus HixlCSClientQueryCompleteStatus(HixlClientHandle client_handle,
                                           CompleteHandle complete_handle,
                                           HixlCompleteStatus *complete_status);

Parameters

Parameter

Input/Output

Description

client_handle

Input

Client handle.

complete_handle

Input

Handle of the task to be queried.

complete_status

Output

Task status enumeration (see HixlCompleteStatus).

Returns

  • HIXL_SUCCESS: The query is successful. The transmission status needs to be determined based on complete_status.
  • HIXL_PARAM_INVALID: Incorrect parameter.
  • Other values: Failure.

Constraints

  • A maximum of 4,000 data records can be concurrently transmitted. After a task is delivered, the HixlCSClientQueryCompleteStatus API must be called in a timely manner to query the task status.
  • If the queried transmission task status is HIXL_COMPLETE_STATUS_COMPLETED, related resources are automatically released. The same complete_handle cannot be used to perform another query.
  • If the queried transmission task status is HIXL_COMPLETE_STATUS_WAITING, you need to determine whether the current transmission task has timed out. If the task has timed out, you can re-establish the transmission link and destroy the current abnormal link.