'\" t
.\"     Title: clGetProgramBuildInfo
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLGETPROGRAMBUILDINF" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clGetProgramBuildInfo \- Returns build information for each device in the program object\&.
.SH ""
.HP \w'cl_int\ clGetProgramBuildInfo('u
.BI "cl_int clGetProgramBuildInfo(cl_program\ " "program" ", cl_device_id\ " "device" ", cl_program_build_info\ " "param_name" ", size_t\ " "param_value_size" ", void\ *" "param_value" ", size_t\ *" "param_value_size_ret" ");"
.SH "PARAMETERS"
.PP
\fIprogram\fR
.RS 4
Specifies the program object being queried\&.
.RE
.PP
\fIdevice\fR
.RS 4
Specifies the device for which build information is being queried\&.
\fIdevice\fR
must be a valid device associated with
\fIprogram\fR\&.
.RE
.PP
\fI param_name \fR
.RS 4
Specifies the information to query\&. The list of supported
\fIparam_name\fR
types and the information returned in
\fIparam_value\fR
by
\fBclGetProgramBuildInfo\fR
is described in the table below\&.
.TS
allbox tab(:);
lB lB.
T{
cl_program_buid_info
T}:T{
Return Type and Info\&. returned in \fIparam_value\fR
T}
.T&
l l
l l
l l
l l.
T{
\fBCL_PROGRAM_BUILD_STATUS\fR
T}:T{
Return type: cl_build_status

Returns the build, compile or link status, whichever was performed last on program for
\fIdevice\fR\&.
.sp
This can be one of the following:
.sp
\fBCL_BUILD_NONE\fR\&. The build status returned if no
\fBclBuildProgram\fR(3clc),
\fBclCompileProgram\fR(3clc)
or
\fBclLinkProgram\fR(3clc)
has been performed on the specified program object for
\fIdevice\fR\&.
.sp
\fBCL_BUILD_ERROR\fR\&. The build status returned if
\fBclBuildProgram\fR(3clc),
\fBclCompileProgram\fR(3clc)
or
\fBclLinkProgram\fR(3clc)
whichever was performed last on the specified program object for device generated an error\&.
.sp
\fBCL_BUILD_SUCCESS\fR\&. The build status returned if
\fBclBuildProgram\fR(3clc),
\fBclCompileProgram\fR(3clc)
or
\fBclLinkProgram\fR(3clc)
whichever was performed last on the specified program object for
\fIdevice\fR
was successful\&.
.sp
\fBCL_BUILD_IN_PROGRESS\fR\&. The build status returned if
\fBclBuildProgram\fR(3clc),
\fBclCompileProgram\fR(3clc)
or
\fBclLinkProgram\fR(3clc)
whichever was performed last on the specified program object for
\fIdevice\fR
has not finished\&.
T}
T{
\fBCL_PROGRAM_BUILD_OPTIONS\fR
T}:T{
Return type: char[]

Return the build, compile or link options specified by the options argument in
\fBclBuildProgram\fR(3clc),
\fBclCompileProgram\fR(3clc)
or
\fBclLinkProgram\fR(3clc), whichever was performed last on program for
\fIdevice\fR\&.
.sp
If build status of
\fIprogram\fR
for
\fIdevice\fR
is
CL_BUILD_NONE, an empty string is returned\&.
T}
T{
\fBCL_PROGRAM_BUILD_LOG\fR
T}:T{
Return type: char[]

Return the build, compile or link log for
\fBclBuildProgram\fR(3clc),
\fBclCompileProgram\fR(3clc)
or
\fBclLinkProgram\fR(3clc)
whichever was performed last on program for
\fIdevice\fR\&.
.sp
If build status of program for device is
\fBCL_BUILD_NONE\fR, an empty string is returned\&.
T}
T{
\fBCL_PROGRAM_BINARY_TYPE\fR
T}:T{
Return type: cl_program_binary_type

Return the program binary type for
\fIdevice\fR\&. This can be one of the following values:
.sp
\fBCL_PROGRAM_BINARY_TYPE_NONE\fR\&. There is no binary associated with
\fIdevice\fR\&.
.sp
\fBCL_PROGRAM_BINARY_TYPE_COMPILED_OBJECT\fR\&. A compiled binary is associated with
\fIdevice\fR\&. This is the case if program was created using
\fBclCreateProgramWithSource\fR(3clc)
and compiled using
\fBclCompileProgram\fR(3clc)
or a compiled binary is loaded using
\fBclCreateProgramWithBinary\fR(3clc)\&.
.sp
\fBCL_PROGRAM_BINARY_TYPE_LIBRARY\fR\&. A library binary is associated with
\fIdevice\fR\&. This is the case if program was created by
\fBclLinkProgram\fR(3clc)
which is called with the \(encreatelibrary link option or if a library binary is loaded using
\fBclCreateProgramWithBinary\fR(3clc)\&.
.sp
\fBCL_PROGRAM_BINARY_TYPE_EXECUTABLE\fR\&. An executable binary is associated with
\fIdevice\fR\&. This is the case if program was created by
\fBclLinkProgram\fR(3clc)
without the \(encreatelibrary link option or program was created by
\fBclBuildProgram\fR(3clc)
or an executable binary is loaded using
\fBclCreateProgramWithBinary\fR(3clc)\&.
T}
.TE
.sp 1
.RE
.PP
\fIparam_value\fR
.RS 4
A pointer to memory where the appropriate result being queried is returned\&. If
\fIparam_value\fR
is NULL, it is ignored\&.
.RE
.PP
\fIparam_value_size\fR
.RS 4
Specifies the size in bytes of memory pointed to by
\fIparam_value\fR\&. This size must be ≥ size of return type as described in the table above\&.
.RE
.PP
\fIparam_value_size_ret\fR
.RS 4
Returns the actual size in bytes of data copied to
\fIparam_value\fR\&. If
\fIparam_value_size_ret\fR
is NULL, it is ignored\&.
.RE
.SH "NOTES"
.PP
A program binary (compiled binary, library binary or executable binary) built for a parent device can be used by all its sub\-devices\&. If a program binary has not been built for a sub\-device, the program binary associated with the parent device will be used\&.
.PP
A program binary for a device specified with
\fBclCreateProgramWithBinary\fR(3clc)
or queried using
\fBclGetProgramInfo\fR(3clc)
can be used as the binary for the associated root device, and all sub\-devices created from the root\-level device or sub\-devices thereof\&.
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the function is executed successfully\&. Otherwise it returns the following:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

Returns CL_INVALID_DEVICE if \fIdevice\fR
is not in the list of devices associated with \fIprogram\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

Returns CL_INVALID_VALUE if \fIparam_name\fR is
not valid, or if size in bytes specified by \fIparam_value_size\fR
is < size of return type as described in the table above and
\fIparam_value\fR is not NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

Returns CL_INVALID_PROGRAM if \fIprogram\fR
is a not a valid program object\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclGetProgramInfo\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 153, section 5.6.7 - Program Object Queries
.RE