~~NOTOC~~

====== clGetPlatformInfo ======

Holt spezifische Informationen über eine OpenCL-Plattform.

===== Signatur =====

<code cpp>
cl_int clGetPlatformInfo( cl_platform_id platform,
                          cl_platform_info param_name,
                          size_t param_value_size,
                          void *param_value,
                          size_t *param_value_size_ret)
</code>

===== Parameter =====

**platform:** Die Plattform ID, die von //clGetPlatformIDs// zurückgegeben wurde oder NULL. Wenn die Plattform ID NULL ist, dann ist das Verhalten implementationsabhängig.

**param_name:** Eine Konstante (Enumeration), die angibt welche Information über die Plattform ermittelt werden soll. Folgende Werte sind möglich (einzeln!):

^ Wert ^ Rückgabetyp ^ Beschreibung ^
| CL_PLATFORM_PROFILE | char[] | Der OpenCL Profile-String. Gibt den Profil-Namen der OpenCL Implementation zurück. Kann einer der folgenden sein: //FULL_PROFILE// - die Implementation unterstützt die OpenCL-Spezifikation (Core Spezifikation). //EMBEDDED_PROFILE// - Die Implemenation unterstützt das eingebettete OpenCL Profil. Das eingebettete Profil ist eine Untermenge von den OpenCL Versionen |
| CL_PLATFORM_VERSION | char[] | OpenCL Versionsstring. Gibt die von der Implementation unterstützte Version von OpenCL zurück. Format: "OpenCL <major_version>.<minor_version> <platform-spezifische-Information>" |
| CL_PLATFORM_NAME | char[] | Der Name der Plattform als String |
| CL_PLATFORM_VENDOR | char[] | Der Hersteller der Plattform als String |
| CL_PLATFORM_EXTENSIONS | char[] | gibt eine Liste der OpenCL-Erweiterungen zurück (durch Leerzeichen getrennt), die von der Plattform unterstützt werden. Erweiterungen, die zurückgegeben werden, müssen von jedem Gerät dieser Plattform unterstützt werden. |

**param_value:** Zeiger auf einen Speicherblock, wohin die Werte geschrieben werden sollen. Die Rückgabetypen können der oben stehenden Tabelle entnommen werden.

**param_value_size:** gibt die Größe in Bytes an, die der Speicherblock, auf den von //param_value// referenziert wird, inne hat. Die Anzahl Bytes muss größer sein als die Größe des angegebenen Rückgabetypen. 

**param_value_size_ret:** gibt die tatsächliche Anzahl zurückgegebener Bytes zurück, die von //param_value// geschrieben wurden. Falls NULL, wird der Parameter ignoriert. 

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

Folgende Rückgabewerte / Fehlercodes sind möglich:

^ Wert ^ Beschreibung ^
| CL_SUCCESS | Die Funktion wurde erfolgreich ausgeführt |
| CL_INVALID_PLATFORM | Die übergebene //platform// ist nicht gültig |
| CL_INVALID_VALUE | //param_name// hat einen nicht unterstützten Wert oder die Größe, die durch //param_value_size// ist kleiner als die Größe des Rückgabewertes und //param_value// ist nicht NULL |
| 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. |

===== Hinweise =====

Wenn als Rückgabetyp der Werte //char[]// angegeben ist, werden nullterminierte Zeichenketten zurückgegeben.

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

  * [[clgetplatformids|clGetPlatformIDs]]