clIcdGetPlatformIDsKHR
clIcdGetPlatformIDsKHR
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.
3
clIcdGetPlatformIDsKHR Obtain the list of platforms accessible through the Khronos ICD Loader.

##

cl_int `clIcdGetPlatformIDsKHR` cl_uint num_entries cl_platform_id *platforms cl_uint *num_platforms

## Parameters

`num_entries`

  The number of cl_platform_id entries that can be added to `platforms`. If `platforms` is not NULL, then `num_entries` must be greater than zero.

`platforms`

  Returns a list of OpenCL platforms available for access through the Khronos ICD Loader. The cl_platform_id values returned in `platforms` are ICD compatible and can be used to identify a specific OpenCL platform. If the `platforms` argument is NULL, then this argument is ignored. The number of OpenCL platforms returned is the minimum of the value specified by `num_entries` or the number of OpenCL platforms available.

`num_platforms`

  Returns the number of OpenCL platforms available. If `num_platforms` is NULL, then this argument is ignored.

## Notes

This function is enabled by the cl_khr_icd extension.

## Errors

Returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns the following:

- CL_PLATFORM_NOT_FOUND_KHR if zero platforms are available.
- CL_INVALID_VALUE if `num_entries` is equal to zero and `platforms` is not NULL or if both `num_platforms` and `platforms` are NULL.

## Specification

OpenCL Specification

## Also see

clGetPlatformIDs, cl_khr_icd

##