clRetainCommandQueue3clc
Increments the command_queue reference count.
cl_int clRetainCommandQueue(cl_command_queue command_queue);
Parameters
command_queue
Specifies the command-queue to retain.
Notes
clCreateCommandQueue(3clc) performs an implicit retain. This is very helpful for 3rd party libraries, which typically get a command-queue passed to them by the application. However, it is possible that the application may delete the command-queue without informing the library. Allowing functions to attach to (i.e. retain) and release a command-queue solves the problem of a command-queue being used by a library no longer being valid.
Errors
Returns CL_SUCCESS if the function executed successfully, or one of the errors below:
• CL_INVALID_COMMAND_QUEUE if command_queue is not a valid command-queue.
• CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.
• CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.
Specification
OpenCL Specification[1]
Notes
- 1.
-
OpenCL Specification
page 62, section 5.1 - Command Queues
Releases
5 releases since Debian 8 (Jessie); the text changed 3 times.