~~NOTOC~~

====== clGetPlatformIDs ======

Holt die Liste der Plattformen, die verfügbar sind.

===== Signatur =====

<code cpp>
cl_int clGetPlatformIDs( cl_uint num_entries,
                         cl_platform_id *platforms,
                         cl_uint *num_platforms)
</code>

===== Parameter =====

**num_entries:** Die Größe des Speicherstücks //platforms//

**platforms:** gibt die Liste der gefunden OpenCL-Plattformen zurück. Die IDs können dazu benutzt werden die Plattformen zu identifizieren. Wenn der Zeiger NULL ist, dann wird er ignoriert. Es werden maximal so viele Plattformen zurückgegeben, wie der erste Parameter angibt oder so viele wie gefunden werden. 

**num_platforms:** gibt die Anzahl der verfügbaren Plattformen zurück. Wenn das Argument NULL ist, wird es ignoriert.

===== Rückgabewert =====

Zurückgegeben wird einer der folgenden Fehlercodes:

^ Rückgabewert ^ Bedeutung ^
| CL_SUCCESS | Die Funktion wurde erfolgreich ausgeführt. Wenn cl_khr_icd-Extention aktiviert ist, gibt CL_SUCCESS an, dass die Funktion erfolgreich ausgeführt wurde und eine Anzhal von Plattformen gefunden wurde, die größer als 1 ist. |
| CL_INVALID_VALUE | Die Argumente sind ungültig. Zum Beispiel kann der erste Parameter 0 sein, der zweite allerdings der NULL-Zeiger, oder sowohl der zweite als auch der dritte Parameter sind NULL-Zeiger |
| CL_OUT_OF_HOST_MEMORY | Es ist ein Fehler beim Reservieren von Speicher aufgetreten, der für die OpenCL-Implementation auf dem Hostprozressor gebraucht wird. |
| CL_PLATFORM_NOT_FOUND_KHR | die cl_khr_icd-Extention ist aktiviert aber es wurden keine Plattformen gefunden. |

===== Siehe auch =====

  * [[clgetplatforminfo|clGetPlatformInfo]]