| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" | |
| "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> | |
| <refentry> | |
| <refentryinfo> | |
| <keywordset> | |
| <keyword>clRetainContext</keyword> | |
| </keywordset> | |
| </refentryinfo> | |
| <refmeta> | |
| <refentrytitle> | |
| clRetainContext | |
| </refentrytitle> | |
| <refmiscinfo> | |
| <copyright> | |
| <year>2007-2013</year> | |
| <holder>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.</holder> | |
| </copyright> | |
| </refmiscinfo> | |
| <manvolnum>3</manvolnum> | |
| </refmeta> | |
| <!-- ================================ SYNOPSIS --> | |
| <refnamediv id="clGetDeviceIDs"> | |
| <refname> | |
| clRetainContext | |
| </refname> | |
| <refpurpose> | |
| Increment the <varname>context</varname> reference count. | |
| </refpurpose> | |
| </refnamediv> | |
| <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="scalarDataTypes.html">cl_int</link> | |
| <function> | |
| clRetainContext | |
| </function> | |
| </funcdef> | |
| <paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| </refsynopsisdiv> | |
| <!-- ================================ PARAMETERS --> | |
| <refsect1 id="parameters"> | |
| <title>Parameters</title> | |
| <variablelist> | |
| <varlistentry> | |
| <term> | |
| <varname> <!-- parameter name --> | |
| context | |
| </varname> | |
| </term> | |
| <listitem> | |
| <para> <!-- parameter description --> | |
| The context to retain. | |
| </para> | |
| </listitem> | |
| </varlistentry> | |
| </variablelist> | |
| </refsect1> | |
| <!-- ================================ NOTES --> | |
| <refsect1 id="notes"><title>Notes</title> | |
| <para> | |
| <citerefentry><refentrytitle>clCreateContext</refentrytitle></citerefentry> and | |
| <citerefentry><refentrytitle>clCreateContextFromType</refentrytitle></citerefentry> | |
| perform an implicit retain. This is very helpful for 3rd party libraries, which | |
| typically get a context passed to them by the application. However, it is possible | |
| that the application may delete the context without informing the library. Allowing | |
| functions to attach to (i.e. retain) and release a context solves the problem of a | |
| context being used by a library no longer being valid. | |
| </para> | |
| </refsect1> | |
| <!-- ================================ ERRORS --> | |
| <refsect1 id="errors"><title>Errors</title> | |
| <para> | |
| Returns <errorname>CL_SUCCESS</errorname> if the function is executed | |
| successfully. Otherwise, it returns one of the following values: | |
| </para> | |
| <itemizedlist mark="disc"> | |
| <listitem> | |
| <errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not a valid OpenCL context. | |
| </listitem> | |
| <listitem> | |
| <errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate resources required by the | |
| OpenCL implementation on the device. | |
| </listitem> | |
| <listitem> | |
| <errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate resources required by the | |
| OpenCL implementation on the host. | |
| </listitem> | |
| </itemizedlist> | |
| </refsect1> | |
| <!-- ================================ EXAMPLE --> | |
| <!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE --> | |
| <!-- | |
| <refsect2 id="example1"> | |
| <title> | |
| Example | |
| </title> | |
| <informaltable frame="none"> | |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> | |
| <colspec colname="col1" colnum="1" /> | |
| <tbody> | |
| <row> | |
| <entry> | |
| Example goes here - it will be set in "code" type with white space preserved. | |
| </entry> | |
| </row> | |
| </tbody> | |
| </tgroup> | |
| </informaltable> | |
| </refsect2> | |
| --> | |
| <!-- ================================ SPECIFICATION --> | |
| <!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page | |
| --> | |
| <refsect1 id="specification"><title>Specification</title> | |
| <para> | |
| <imageobject> | |
| <imagedata fileref="pdficon_small1.gif" format="gif" /> | |
| </imageobject> | |
| <olink uri="clRetainContext">OpenCL Specification</olink> | |
| </para> | |
| </refsect1> | |
| <!-- ================================ ALSO SEE --> | |
| <refsect1 id="seealso"><title>Also see</title> | |
| <para> | |
| <citerefentry><refentrytitle>clCreateContext</refentrytitle></citerefentry>, | |
| <citerefentry><refentrytitle>clCreateContextFromType</refentrytitle></citerefentry>, | |
| <citerefentry><refentrytitle>clGetContextInfo</refentrytitle></citerefentry>, | |
| <citerefentry><refentrytitle>clReleaseContext</refentrytitle></citerefentry>, | |
| <citerefentry><refentrytitle>clGetContextInfo</refentrytitle></citerefentry> | |
| </para> | |
| </refsect1> | |
| <!-- ================================ COPYRIGHT --> | |
| <!-- Content included from copyright.inc.xsl --> | |
| <refsect3 id="Copyright"><title></title> | |
| <imageobject> | |
| <imagedata fileref="KhronosLogo.jpg" format="jpg" /> | |
| </imageobject> | |
| <para /> | |
| </refsect3> | |
| <!-- 6-May-2013 --> | |
| </refentry> | |