feedc0de/boost_system
1
0
Fork 0
forked from boostorg/system
Code Pull Requests Activity

System: refine docs for semantics of throws object

Browse Source 
[SVN r49177]
This commit is contained in:
Beman Dawes
2008-10-08 14:16:05 +00:00
parent b4cc289238
commit 214ed40b22
1 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/reference.html
View File

@ -619,18 +619,26 @@ for use as a &quot;throw on error&quot; tag.</p>
with appropriate namespace qualifiers, have the following error handling
semantics:</p>
<blockquote>
<p><i>Effects:</i> If <code>ec != throws</code>:</p>
<ul>
<li>If an error occurs, and sets <code>ec</code> to an appropriate <code>
<a href="#Class-error_code">error_code</a></code> that identifies the error
value and category. The category should be the most specific <code>
<a href="#Class-error_category">error_category</a></code> applicable to the
particular error.</li>
<li>if an error does not occur, <code>ec.clear()</code>.</li>
</ul>
<p><i>Throws:</i> If <code>ec == throws</code>, throws an exception of type
<p><i>Postconditions:</i></p>
<blockquote>
<p>If <code>&amp;ec != &amp;throws</code> and an error occurred:</p>
<ul>
<li> <code>ec.value()</code> returns the implementation specific error
number for the particular error that occurred.</li>
<li><code>ec.category()</code> returns the <code>
<a href="#Class-error_category">error_category</a></code> for <code>ec.value()</code>.</li>
</ul>
<p>if <code>&amp;ec != &amp;throws</code> and an error did not occur, <code>ec.clear()</code>.</p>
</blockquote>
<p><i>Throws:</i></p>
<blockquote>
<p>If an error occurs and <code>&amp;ec == &amp;throws</code>, throws an exception of type
<code><a href="#Class-system_error">system_error</a></code> or of a type
derived from <code><a href="#Class-system_error">system_error</a></code>.</p>
derived from <code><a href="#Class-system_error">system_error</a></code>. The
exception's <code>code()</code> member function returns a reference to an
<code>error_code</code> object with the behavior specified in <i>
Postconditions</i>.</p>
</blockquote>
</blockquote>
<h2><a name="Non-member-functions">Non-member functions</a></h2>
<pre>bool operator==( const error_code &amp; lhs, const error_code &amp; rhs );</pre>
@ -783,7 +791,7 @@ application program interfaces.</p>
<hr>
<p>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->October 05, 2008<!--webbot bot="Timestamp" endspan i-checksum="30983" --> </font>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->October 08, 2008<!--webbot bot="Timestamp" endspan i-checksum="30989" --> </font>
</p>
<p><EFBFBD> Copyright Beman Dawes, 2006, 2007, 2008</p>