---
name: "clGetKernelInfo"
section: "3clc"
platform: "linux"
package: "opencl-1.2-man-doc"
version: "1.0~svn33624-5.1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/clGetKernelInfo"
---

# clGetKernelInfo(3clc)

Returns information about the kernel object.

## NAME

clGetKernelInfo - Returns information about the kernel object.

##

**cl\_int clGetKernelInfo(cl\_kernel** *kernel***, cl\_kernel\_info** *param\_name***, size\_t** *param\_value\_size***, void \****param\_value***, size\_t \****param\_value\_size\_ret***);**

## PARAMETERS

 *kernel*

Specifies the kernel object being queried.

 *param\_name*

Specifies the information to query. The list of supported *param\_name* types and the information returned in *param\_value* by **clGetKernelInfo** is described in the table below.

 *param\_value*

A pointer to memory where the appropriate result being queried is returned. If *param\_value* is NULL, it is ignored.

 *param\_value\_size*

Used to specify the size in bytes of memory pointed to by *param\_value*. This size must be ≥ size of return type as described in the table below.

| | | |
| --- | --- | --- |
| **cl\_kernel\_info** | **Return Type** | **Info. returned in *param\_value*** |
| **CL\_KERNEL\_FUNCTION\_NAME** | char\[\] | Return the kernel function name. |
| **CL\_KERNEL\_NUM\_ARGS** | cl\_uint | Return the number of arguments to *kernel*. |
| **CL\_KERNEL\_REFERENCE\_COUNT** | cl\_uint | Return the *kernel* reference count. |
| **CL\_KERNEL\_CONTEXT** | cl\_context | Return the context associated with *kernel*. |
| **CL\_KERNEL\_PROGRAM** | cl\_program | Return the program object associated with *kernel*. |
| **CL\_KERNEL\_ATTRIBUTES** | char\[\] | Returns any attributes specified using the \_\_[**attribute**(3clc)](/attribute/3clc.md)\_\_ qualifier with the kernel function declaration in the program source. These attributes include those on the \_\_[**attribute**(3clc)](/attribute/3clc.md)\_\_ page and other attributes supported by an implementation. Attributes are returned as they were declared inside \_\_[**attribute**(3clc)](/attribute/3clc.md)\_\_((...)), with any surrounding whitespace and embedded newlines removed. When multiple attributes are present, they are returned as a single, space delimited string. |

 *param\_value\_size\_ret*

the actual size in bytes of data copied to *param\_value*. If *param\_value\_size\_ret* is NULL, it is ignored.

## ERRORS

Returns CL\_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:

• CL\_INVALID\_VALUE if *param\_name* is not valid, or if size in bytes specified by  *param\_value\_size* is \< size of return type as described in the table above and *param\_value* is not NULL.

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

## SPECIFICATION

**OpenCL Specification**\[1\]

## SEE ALSO

[**clCreateKernel**(3clc)](/clCreateKernel/3clc.md), [**clCreateKernelsInProgram**(3clc)](/clCreateKernelsInProgram/3clc.md), [**clGetKernelArgInfo**(3clc)](/clGetKernelArgInfo/3clc.md), [**clRetainKernel**(3clc)](/clRetainKernel/3clc.md), [**clReleaseKernel**(3clc)](/clReleaseKernel/3clc.md), [**clSetKernelArg**(3clc)](/clSetKernelArg/3clc.md), [**clGetKernelWorkGroupInfo**(3clc)](/clGetKernelWorkGroupInfo/3clc.md)

## AUTHORS

**The Khronos Group**

## COPYRIGHT

Copyright © 2007-2011 The Khronos Group Inc.\
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.

## NOTES

- 1\.

  OpenCL Specification

  page 162, section 5.7.3 - Kernel Object Queries (updated for 1.2 rev 14)