C Specification

To retain a kernel object, call the function

// Provided by CL_VERSION_1_0
cl_int clRetainKernel(
    cl_kernel kernel);

Parameters

  • kernel is the kernel object to be retained.

Description

The kernel reference count is incremented.

clRetainKernel returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:

  • CL_INVALID_KERNEL if kernel is not a valid kernel object.

  • 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.

clCreateKernel or clCreateKernelsInProgram do an implicit retain.

See Also

CL_VERSION_1_0, cl_kernel

Document Notes

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

Copyright 2014-2025 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0