'\" t
.\"     Title: clGetCommandQueueInfo
.\"    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 "CLGETCOMMANDQUEUEINF" "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"
clGetCommandQueueInfo \- Query information about a command\-queue\&.
.SH ""
.HP \w'cl_int\ clGetCommandQueueInfo('u
.BI "cl_int clGetCommandQueueInfo(cl_command_queue\ " "command_queue" ", cl_command_queue_info\ " "param_name" ", size_t\ " "param_value_size" ", void\ *" "param_value" ", size_t\ *" "param_value_size_ret" ");"
.SH "PARAMETERS"
.PP
\fIcommand_queue\fR
.RS 4
Specifies the command\-queue being queried\&.
.RE
.PP
\fIparam_name\fR
.RS 4
Specifies the information to query\&.
.RE
.PP
\fIparam_value_size\fR
.RS 4
Specifies the size in bytes of memory pointed to by
\fIparam_value\fR\&. This size must be ≥ size of return type as described in the table below\&. If
\fIparam_value\fR
is NULL, it is ignored\&.
.RE
.PP
\fIparam_value\fR
.RS 4
A pointer to memory where the appropriate result being queried is returned\&. If
\fIparam_value\fR
is NULL, it is ignored\&.
.RE
.PP
\fIparam_value_size_ret\fR
.RS 4
Returns the actual size in bytes of data being queried by
\fIparam_value\fR\&. If
\fIparam_value_size_ret\fR
is NULL, it is ignored
.RE
.PP
.RS 4
The list of supported
\fIparam_name\fR
values and the information returned in
\fIparam_value\fR
by
\fBclGetCommandQueueInfo\fR
is described in the table below\&.
.TS
allbox tab(:);
lB lB.
T{
cl_command_queue_info
T}:T{
Return Type and Information returned in param_value
T}
.T&
l l
l l
l l
l l.
T{
\fBCL_QUEUE_CONTEXT\fR
T}:T{
Return type: \fBcl_context\fR

Return the context specified when the command\-queue is created\&.
T}
T{
\fBCL_QUEUE_DEVICE\fR
T}:T{
Return type: \fBcl_device_id\fR

Return the device specified when the command\-queue is created\&.
T}
T{
\fBCL_QUEUE_REFERENCE_COUNT\fR
T}:T{
Return type: \fBcl_uint\fR

Return the command\-queue reference count\&.
.sp                      The reference count returned with
\fBCL_QUEUE_REFERENCE_COUNT\fR
should be considered immediately stale\&. It is unsuitable for general use in applications\&. This feature is provided for identifying memory leaks\&.
T}
T{
\fBCL_QUEUE_PROPERTIES\fR
T}:T{
Return type: \fBcl_command_queue_properties\fR

Return the currently specified properties for the command\-queue\&. These properties are specified by the
\fIproperties\fR
argument in
\fBclCreateCommandQueue\fR(3clc)\&.
T}
.TE
.sp 1
.RE
.SH "NOTES"
.PP
It is possible that a device(s) becomes unavailable after a context and command\-queues that use this device(s) have been created and commands have been queued to command\-queues\&. In this case the behavior of OpenCL API calls that use this context (and command\-queues) are considered to be implementation\-defined\&. The user callback function, if specified, when the context is created can be used to record appropriate information in the
\fIerrinfo\fR,
\fIprivate_info\fR
arguments passed to the callback function when the device becomes unavailable\&.
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the function is executed successfully\&. Otherwise, it returns the following:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

Returns CL_INVALID_COMMAND_QUEUE if
\fIcommand_queue\fR is not a valid command\-queue\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

Returns CL_INVALID_VALUE if \fIparam_name\fR
is not one of the supported values or if size in bytes specified by
\fIparam_value_size\fR is less than size of return type and
\fIparam_value\fR is not a NULL value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclCreateCommandQueue\fR(3clc),
\fBclReleaseCommandQueue\fR(3clc),
\fBclRetainCommandQueue\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 63, section 5.1 - Command Queues
.RE