C Specification
To create a program object for a context and load source code into that object, call the function
// Provided by CL_VERSION_1_0
cl_program clCreateProgramWithSource(
cl_context context,
cl_uint count,
const char** strings,
const size_t* lengths,
cl_int* errcode_ret);Parameters
-
context must be a valid OpenCL context.
-
strings is an array of count pointers to optionally null-terminated character strings that make up the source code.
-
lengths argument is an array with the number of chars in each string (the string length). If an element in lengths is zero, its accompanying string is null-terminated. If lengths is
NULL, all strings in the strings argument are considered null-terminated. Any length value passed in that is greater than zero excludes the null terminator in its count. -
errcode_ret will return an appropriate error code. If errcode_ret is
NULL, no error code is returned.
Description
The devices associated with the program object are the devices associated with context.
The source code specified by strings are loaded into the program object.
The source languages supported for strings are defined by device queries such
as CL_DEVICE_.
clCreateProgramWithSource returns a valid non-zero program object and
errcode_ret 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 errcode_ret:
-
CL_INVALID_if context is not a valid context.CONTEXT -
CL_INVALID_if count is zero or if strings or any entry in strings isVALUE NULL. -
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the device.OF_ RESOURCES -
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the host.OF_ HOST_ MEMORY
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.