clGetProgramBuildInfo

Returns build information for each device in the program object.

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)

Parameters

program

Specifies the program object being queried.

device

Specifies the device for which build information is being queried. device must be a valid device associated with program.

param_name

Specifies the information to query. The list of supported param_name types and the information returned in param_value by clGetProgramBuildInfo is described in the table below.

cl_program_buid_info Return Type and Info. returned in param_value
CL_PROGRAM_BUILD_STATUS Return type: cl_build_status

Returns the build status of program for a specific device as given by device. This can be one of the following:

CL_BUILD_NONE. The build status returned if no build has been performed on the specified program object for device.

CL_BUILD_ERROR. The build status returned if the last call to clBuildProgram on the specified program object for device generated an error.

CL_BUILD_SUCCESS. The build status returned if the last call to clBuildProgram on the specified program object for device was successful.

CL_BUILD_IN_PROGRESS. The build status returned if the last call to clBuildProgram on the specified program object for device has not finished.

CL_PROGRAM_BUILD_OPTIONS Return type: char[]

Return the build options specified by the options argument in clBuildProgram for device.

If build status of program for device is CL_BUILD_NONE, an empty string is returned.

CL_PROGRAM_BUILD_LOG Return type: char[]

Return the build log when clBuildProgram was called for device. If build status of program for device is CL_BUILD_NONE, an empty string is returned.
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

Specifies the size in bytes of memory pointed to by param_value. This size must be greater than or equal to the size of return type as described in the table above.

param_value_size_ret

Returns 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 the following:

  • Returns CL_INVALID_DEVICE if device is not in the list of devices associated with program.
  • Returns CL_INVALID_VALUE if param_name is not valid, or if size in bytes specified by param_value_size is less than size of return type and param_value is not NULL.
  • Returns CL_INVALID_PROGRAM if program is a not a valid program 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

Also see

clGetProgramInfo

Copyright © 2007-2010 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.