'\" t
.\"     Title: clGetPlatformIDs
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLGETPLATFORMIDS" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clGetPlatformIDs \- Obtain the list of platforms available\&.
.SH ""
.HP \w'cl_int\ clGetPlatformIDs('u
.BI "cl_int clGetPlatformIDs(cl_uint\ " "num_entries" ", cl_platform_id\ *" "platforms" ", cl_uint\ *" "num_platforms" ");"
.SH "PARAMETERS"
.PP
\fInum_entries\fR
.RS 4
The number of cl_platform_id entries that can be added to
\fIplatforms\fR\&. If
\fIplatforms\fR
is not NULL, the
\fInum_entries\fR
must be greater than zero\&.
.RE
.PP
\fIplatforms\fR
.RS 4
Returns a list of OpenCL platforms found\&. The cl_platform_id values returned in
\fIplatforms\fR
can be used to identify a specific OpenCL platform\&. If
\fIplatforms\fR
argument is NULL, this argument is ignored\&. The number of OpenCL platforms returned is the mininum of the value specified by
\fInum_entries\fR
or the number of OpenCL platforms available\&.
.RE
.PP
\fInum_platforms\fR
.RS 4
Returns the number of OpenCL platforms available\&. If
\fInum_platforms\fR
is NULL, this argument is ignored\&.
.RE
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the function is executed successfully\&. Otherwise it returns
CL_INVALID_VALUE
if
\fInum_entries\fR
is equal to zero and
\fIplatforms\fR
is not NULL, or if both
\fInum_platforms\fR
and
\fIplatforms\fR
are NULL\&.
.PP
Returns
CL_OUT_OF_HOST_MEMORY
if there is a failure to allocate resources required by the OpenCL implementation on the host\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclGetPlatformInfo\fR(3clc),
\fBclGetDeviceInfo\fR(3clc),
\fBclassDiagram\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 33, section 4.1 - Querying Platform Info
.RE