<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>clGetEventInfo</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <meta name="keywords" content="clGetEventInfo" />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="clGetEventInfo"></a>
        <h1>clGetEventInfo</h1>
        <p>
            Returns information about the event object.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="scalarDataTypes.html" target="_top">cl_int</a>
                    <strong class="fsfunc">                   
                        clGetEventInfo
                    </strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="_top">cl_event</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">event</var>, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_event_info" target="_top">cl_event_info</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_name</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_value_size</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">void</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value_size_ret</var><code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="parameters"></a>
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                    <code class="varname"> 
                        event
                    </code>
                </span>
            </dt>
            <dd>
              <p> 
                        Specifies the event object being queried.
                    </p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname"> 
                        param_value
                    </code>
                </span>
            </dt>
            <dd>
              <p> 
                         A pointer to memory where the appropriate result being queried is returned. If <code class="varname">param_value</code> is NULL, it is ignored.
                    </p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname"> 
                        param_value_size
                    </code>
                </span>
            </dt>
            <dd>
              <p> 
                         Specifies the size in bytes of memory pointed to by <code class="varname">param_value</code>. This size must be greater than or equal to the size of the return type as described in the table below.
                    </p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname"> 
                        param_value_size_ret
                    </code>
                </span>
            </dt>
            <dd>
              <p> 
                        Returns the actual size in bytes of data copied to <code class="varname">param_value</code>. If
<code class="varname">param_value_size_ret</code> is NULL, it is ignored.
                    </p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname"> 
                        param_name
                    </code>
                </span>
            </dt>
            <dd>
              <p> 
                        Specifies the information to query. The list of supported <code class="varname">param_name</code> types and the information returned in <code class="varname">param_value</code> by <code class="function">clGetEventInfo</code> is described in the table below:

                    </p>
              <div class="informaltable">
                <table border="1">
                  <colgroup>
                    <col align="left" class="col1" />
                    <col align="left" class="col2" />
                    <col align="left" class="col3" />
                  </colgroup>
                  <thead>
                    <tr>
                      <th align="left">cl_event_info</th>
                      <th align="left">Return Type</th>
                      <th align="left">Information returned in <code class="varname">param_value</code></th>
                    </tr>
                  </thead>
                  <tbody>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_EVENT_COMMAND_QUEUE</code>
                      </td>
                      <td align="left">cl_command_queue</td>
                      <td align="left">
                                        Return the command-queue associated with <code class="varname">event</code>. 
                                        For user event objects, a NULL value is returned.
                                    </td>
                    </tr>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_EVENT_CONTEXT</code>
                      </td>
                      <td align="left">cl_context</td>
                      <td align="left">
                                        Return the context associated with <code class="varname">event</code>.
                                    </td>
                    </tr>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_EVENT_COMMAND_TYPE</code>
                      </td>
                      <td align="left">cl_command_type</td>
                      <td align="left">Return the command associated with <code class="varname">event</code>.
                                    Can be one of the following values:
<div class="literallayout"><p>CL_COMMAND_NDRANGE_KERNEL<br />
CL_COMMAND_TASK<br />
CL_COMMAND_NATIVE_KERNEL<br />
CL_COMMAND_READ_BUFFER<br />
CL_COMMAND_WRITE_BUFFER<br />
CL_COMMAND_COPY_BUFFER<br />
CL_COMMAND_READ_IMAGE<br />
CL_COMMAND_WRITE_IMAGE<br />
CL_COMMAND_COPY_IMAGE<br />
CL_COMMAND_COPY_BUFFER_TO_IMAGE<br />
CL_COMMAND_COPY_IMAGE_TO_BUFFER<br />
CL_COMMAND_MAP_BUFFER<br />
CL_COMMAND_MAP_IMAGE<br />
CL_COMMAND_UNMAP_MEM_OBJECT<br />
CL_COMMAND_MARKER<br />
CL_COMMAND_ACQUIRE_GL_OBJECTS<br />
CL_COMMAND_RELEASE_GL_OBJECTS<br />
CL_COMMAND_READ_BUFFER_RECT<br />
CL_COMMAND_WRITE_BUFFER_RECT<br />
CL_COMMAND_COPY_BUFFER_RECT<br />
CL_COMMAND_USER<br />
CL_COMMAND_GL_FENCE_SYNC_OBJECT_KHR <br />
  (if cl_khr_gl_event is enabled)<br />
CL_COMMAND_ACQUIRE_D3D10_OBJECTS_KHR<br />
  (if cl_khr_d3d10_sharing is enabled)<br />
CL_COMMAND_RELEASE_D3D10_OBJECTS_KHR  <br />
  (if cl_khr_d3d10_sharing is enabled)</p></div>
                                    </td>
                    </tr>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_EVENT_COMMAND_ EXECUTION_STATUS</code>
                      </td>
                      <td align="left">cl_int</td>
                      <td align="left">
                                        Return the execution status of the command identified by <code class="varname">event</code>. The valid values are:
<p>CL_QUEUED (command has been enqueued in the command-queue),</p>
<p>CL_SUBMITTED (enqueued command has been submitted by the host to the device associated with the command-queue),</p>
<p>CL_RUNNING (device is currently executing this command),</p>
<p>CL_COMPLETE (the command has completed), or</p>
<p>Error code given by a negative integer value. (command was abnormally terminated – this
may be caused by a bad memory access etc.)</p>
<p>These error codes come from the same set of error codes that are returned from the platform or runtime API calls as return values or <code class="varname">errcode_ret</code> values.</p>
<p>
The error code values are negative, and event state values are positive. The event state values are ordered from the largest value (CL_QUEUED) for the first or initial state to the smallest value (CL_COMPLETE or negative integer value) for the last or complete state. The value of CL_COMPLETE and CL_SUCCESS are the same.
</p>

                                    </td>
                    </tr>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_EVENT_REFERENCE_COUNT</code>
                      </td>
                      <td align="left">cl_uint</td>
                      <td align="left">
                                        Return the <code class="varname">event</code> reference count. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
                                    </td>
                    </tr>
                  </tbody>
                </table>
              </div>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
            Using <code class="function">clGetEventInfo</code> to determine if a command identified by event has finished execution (i.e. <code class="constant">CL_EVENT_COMMAND_EXECUTION_STATUS</code> returns <code class="constant">CL_COMPLETE</code>) is not a synchronization point. There are no guarantees that the memory objects being modified by command associated with <code class="varname">event</code> will be visible to other enqueued commands.
        </p>
      </div>
      <div class="refsect1">
        <a id="errors"></a>
        <h2>Errors</h2>
        <p>
            Returns <span class="errorname">CL_SUCCESS</span> if the function executed successfully, or one of the errors below:
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code> is not valid, or if size in 
                bytes specified by <code class="varname">param_value_size</code> is less than size of return type as described 
                in the table above and <code class="varname">param_value</code> is not NULL.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if information to query given in <code class="varname">param_name</code>
                cannot be queried for event.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_EVENT</span> if <code class="varname">event</code> is not a valid
                 <code class="varname">event</code> object.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate resources required by the 
                OpenCL implementation on the device.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate resources required 
                by the OpenCL implementation on the host.
            </li>
          </ul>
        </div>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />
                                                 
            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf#page=142" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p> 
            <a class="citerefentry" href="clReleaseEvent.html"><span class="citerefentry"><span class="refentrytitle">clReleaseEvent</span></span></a>, 
            <a class="citerefentry" href="clRetainEvent.html"><span class="citerefentry"><span class="refentrytitle">clRetainEvent</span></span></a>, 
            <a class="citerefentry" href="clWaitForEvents.html"><span class="citerefentry"><span class="refentrytitle">clWaitForEvents</span></span></a>, 
            <a class="citerefentry" href="gl_event.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_event</span></span></a>  
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2010 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.
</div>
    </div>
  </body>
</html>