To set the execution status of a user event object, call the function
cl_int clSetUserEventStatus( cl_event event, cl_int execution_status);
event is a user event object created using clCreateUserEvent.
execution_status specifies the new execution status to be set and can be
CL_COMPLETEor a negative integer value to indicate an error. A negative integer value causes all enqueued commands that wait on this user event to be terminated. clSetUserEventStatus can only be called once to change the execution status of event.
If there are enqueued commands with user events in the event_wait_list argument of clEnqueue* commands, the user must ensure that the status of these user events being waited on are set using clSetUserEventStatus before any OpenCL APIs that release OpenCL objects except for event objects are called; otherwise the behavior is undefined.
For example, the following code sequence will result in undefined behavior of clReleaseMemObject.
The following code sequence, however, works correctly.
CL_SUCCESS if the function was executed
Otherwise, it returns one of the following errors:
CL_INVALID_EVENTif event is not a valid user event object.
CL_INVALID_VALUEif the execution_status is not
CL_COMPLETEor a negative integer value.
CL_INVALID_OPERATIONif the execution_status for event has already been changed by a previous call to clSetUserEventStatus.
CL_OUT_OF_RESOURCESif there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_OF_HOST_MEMORYif there is a failure to allocate resources required by the OpenCL implementation on the host.
For more information, see the OpenCL Specification
This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.
Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.