'\" t
.\"     Title: clCreateProgramWithSource
.\"    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 "CLCREATEPROGRAMWITHS" "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"
clCreateProgramWithSource \- Creates a program object for a context, and loads the source code specified by the text strings in the strings array into the program object\&.
.SH ""
.HP \w'cl_program\ clCreateProgramWithSource('u
.BI "cl_program clCreateProgramWithSource(cl_context\ " "context" ", cl_uint\ " "count" ", const\ char\ *" "*strings" ", const\ size_t\ *" "lengths" ", cl_int\ *" "errcode_ret" ");"
.SH "PARAMETERS"
.PP
\fI context \fR
.RS 4
Must be a valid OpenCL context\&.
.RE
.PP
\fI strings \fR
.RS 4
An array of
\fIcount\fR
pointers to optionally null\-terminated character strings that make up the source code\&.
.RE
.PP
\fI lengths \fR
.RS 4
An array with the number of chars in each string (the string length)\&. If an element in
\fIlengths\fR
is zero, its accompanying string is null\-terminated\&. If
\fIlengths\fR
is NULL, all strings in the
\fIstrings\fR
argument are considered null\-terminated\&. Any length value passed in that is greater than zero excludes the null terminator in its count\&.
.RE
.PP
\fI errcode_ret \fR
.RS 4
Returns an appropriate error code\&. If
\fIerrcode_ret\fR
is NULL, no error code is returned\&.
.RE
.SH "DESCRIPTION"
.PP
This function creates a program object for a context, and loads the source code specified by the text strings in the
\fIstrings\fR
array into the program object\&. The devices associated with the program object are the devices associated with
\fIcontext\fR\&. The source code specified by
\fIstrings\fR
is either an OpenCL C program source, header or implementation\-defined source for custom devices that support an online compiler\&.
.SH "ERRORS"
.PP
\fBclCreateProgramWithSource\fR
returns a valid non\-zero program object and
\fIerrcode_ret\fR
is set to
CL_SUCCESS
if the program object is created successfully\&. Otherwise, it returns a NULL value with one of the following error values returned in
\fIerrcode_ret\fR:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_CONTEXT if \fIcontext\fR is not
a valid context\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIcount\fR is zero or
if \fIstrings\fR or any entry in \fIstrings\fR is NULL\&.
.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
\fBclCreateProgramWithBinary\fR(3clc),
\fBclReleaseProgram\fR(3clc),
\fBclRetainProgram\fR(3clc),
\fBclassDiagram\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 132, section 5.6.1 - Creating Program Objects
.RE