1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class context_error</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Compute"> 8<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.exception.context_error_hpp" title="Header <boost/compute/exception/context_error.hpp>"> 9<link rel="prev" href="vector.html" title="Class template vector"> 10<link rel="next" href="no_device_found.html" title="Class no_device_found"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="vector.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.exception.context_error_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="no_device_found.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.context_error"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class context_error</span></h2> 29<p>boost::compute::context_error — A run-time OpenCL context error. </p> 30</div> 31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_compute/reference.html#header.boost.compute.exception.context_error_hpp" title="Header <boost/compute/exception/context_error.hpp>">boost/compute/exception/context_error.hpp</a>> 33 34</span> 35<span class="keyword">class</span> <a class="link" href="context_error.html" title="Class context_error">context_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">exception</span> <span class="special">{</span> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// <a class="link" href="context_error.html#boost.compute.context_errorconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="context_error.html#idm45549385556800-bb"><span class="identifier">context_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> 39 <a class="link" href="context_error.html#idm45549385553440-bb"><span class="special">~</span><span class="identifier">context_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 40 41 <span class="comment">// <a class="link" href="context_error.html#idm45549385563440-bb">public member functions</a></span> 42 <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="context_error.html#idm45549385562880-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 43 <span class="keyword">const</span> <span class="identifier">context</span> <span class="special">*</span> <a class="link" href="context_error.html#idm45549385561440-bb"><span class="identifier">get_context_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 44 <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="context_error.html#idm45549385559840-bb"><span class="identifier">get_private_info_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 45 <span class="identifier">size_t</span> <a class="link" href="context_error.html#idm45549385558400-bb"><span class="identifier">get_private_info_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 46<span class="special">}</span><span class="special">;</span></pre></div> 47<div class="refsect1"> 48<a name="idm45849511726512"></a><h2>Description</h2> 49<p>The <a class="link" href="context_error.html" title="Class context_error">context_error</a> exception is thrown when the OpenCL context encounters an error condition. Boost.Compute is notified of these error conditions by registering an error handler when creating context objects (via the <code class="computeroutput">pfn_notify</code> argument to the <code class="computeroutput">clCreateContext()</code> function).</p> 50<p>This exception is different than the <a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> exception which is thrown as a result of error caused when calling a single OpenCL API function.</p> 51<p><span class="bold"><strong>See Also:</strong></span></p> 52<p><a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> </p> 53<p> 54</p> 55<p> 56</p> 57<div class="refsect2"> 58<a name="idm45849511720000"></a><h3> 59<a name="boost.compute.context_errorconstruct-copy-destruct"></a><code class="computeroutput">context_error</code> 60 public 61 construct/copy/destruct</h3> 62<div class="orderedlist"><ol class="orderedlist" type="1"> 63<li class="listitem"> 64<pre class="literallayout"><a name="idm45549385556800-bb"></a><span class="identifier">context_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">*</span> context<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> errinfo<span class="special">,</span> 65 <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> private_info<span class="special">,</span> <span class="identifier">size_t</span> private_info_size<span class="special">)</span><span class="special">;</span></pre>Creates a new context error exception object. </li> 66<li class="listitem"> 67<pre class="literallayout"><a name="idm45549385553440-bb"></a><span class="special">~</span><span class="identifier">context_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the context error object. </li> 68</ol></div> 69</div> 70<div class="refsect2"> 71<a name="idm45849511700768"></a><h3> 72<a name="idm45549385563440-bb"></a><code class="computeroutput">context_error</code> public member functions</h3> 73<div class="orderedlist"><ol class="orderedlist" type="1"> 74<li class="listitem"> 75<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idm45549385562880-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a string with a description of the error. </li> 76<li class="listitem"> 77<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">*</span> <a name="idm45549385561440-bb"></a><span class="identifier">get_context_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 78<p>Returns a pointer to the context object which generated the error notification. </p> 79</li> 80<li class="listitem"> 81<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <a name="idm45549385559840-bb"></a><span class="identifier">get_private_info_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a pointer to the private info memory block. </li> 82<li class="listitem"> 83<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm45549385558400-bb"></a><span class="identifier">get_private_info_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the private info memory block. </li> 84</ol></div> 85</div> 86</div> 87</div> 88<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 89<td align="left"></td> 90<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 91 Distributed under the Boost Software License, Version 1.0. (See accompanying 92 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 93 </p> 94</div></td> 95</tr></table> 96<hr> 97<div class="spirit-nav"> 98<a accesskey="p" href="vector.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.exception.context_error_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="no_device_found.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 99</div> 100</body> 101</html> 102
