---
name: "clGetPlatformIDs"
section: "3clc"
platform: "linux"
package: "opencl-1.2-man-doc"
version: "1.0~svn33624-5.1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/clGetPlatformIDs"
---

# clGetPlatformIDs(3clc)

Obtain the list of platforms available.

## NAME

clGetPlatformIDs - Obtain the list of platforms available.

##

**cl\_int clGetPlatformIDs(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, the *num\_entries* must be greater than zero.

*platforms*

Returns a list of OpenCL platforms found. The cl\_platform\_id values returned in *platforms* can be used to identify a specific OpenCL platform. If *platforms* argument is NULL, this argument is ignored. The number of OpenCL platforms returned is the mininum 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, this argument is ignored.

## ERRORS

Returns CL\_SUCCESS if the function is executed successfully. Otherwise it returns CL\_INVALID\_VALUE if *num\_entries* is equal to zero and *platforms* is not NULL, or if both *num\_platforms* and *platforms* are NULL.

Returns CL\_OUT\_OF\_HOST\_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

## SPECIFICATION

**OpenCL Specification**\[1\]

## SEE ALSO

[**clGetPlatformInfo**(3clc)](/clGetPlatformInfo/3clc.md), [**clGetDeviceInfo**(3clc)](/clGetDeviceInfo/3clc.md), [**classDiagram**(3clc)](/classDiagram/3clc.md)

## AUTHORS

**The Khronos Group**

## COPYRIGHT

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

## NOTES

- 1\.

  OpenCL Specification

  page 33, section 4.1 - Querying Platform Info