diff options
| author | Gary Scavone <gary@music.mcgill.ca> | 2013-10-11 01:46:50 +0200 |
|---|---|---|
| committer | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-11 01:46:50 +0200 |
| commit | 0876bbd0bad22677b23342c828bc36c3babbed4e (patch) | |
| tree | dbd91a7beefce7da18aa9319df8328945ad66c77 /doc/html/classRtError.html | |
| parent | 332b0956ae798ea52073fe5b889696a33e0f11f2 (diff) | |
Release 4.0.0 tarball4.0.0
Diffstat (limited to 'doc/html/classRtError.html')
| -rw-r--r-- | doc/html/classRtError.html | 78 |
1 files changed, 36 insertions, 42 deletions
diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html index 23bfd0f..244c52f 100644 --- a/doc/html/classRtError.html +++ b/doc/html/classRtError.html @@ -1,11 +1,12 @@ <HTML> <HEAD> -<TITLE>The RtAudio Tutorial</TITLE> +<TITLE>The RtAudio Home Page</TITLE> <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +<LINK REL="SHORTCUT ICON" HREF="http://www.music.mcgill.ca/~gary/favicon.ico"> </HEAD> <BODY BGCOLOR="#FFFFFF"> <CENTER> -<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<a class="qindex" href="index.html">Home</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> <!-- Generated by Doxygen 1.4.4 --> <h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> & RtMidi. @@ -16,63 +17,61 @@ <a href="classRtError-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#w11">Type</a> { <br> - <a class="el" href="classRtError.html#w11w0">WARNING</a>, -<a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a>, -<a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a>, -<a class="el" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>, +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#w9">Type</a> { <br> + <a class="el" href="classRtError.html#w9w0">UNSPECIFIED</a>, +<a class="el" href="classRtError.html#w9w1">NO_DEVICES_FOUND</a>, +<a class="el" href="classRtError.html#w9w2">INVALID_DEVICE</a>, +<a class="el" href="classRtError.html#w9w3">MEMORY_ERROR</a>, <br> - <a class="el" href="classRtError.html#w11w4">INVALID_DEVICE</a>, -<a class="el" href="classRtError.html#w11w5">INVALID_STREAM</a>, -<a class="el" href="classRtError.html#w11w6">MEMORY_ERROR</a>, -<a class="el" href="classRtError.html#w11w7">INVALID_PARAMETER</a>, + <a class="el" href="classRtError.html#w9w4">INVALID_PARAMETER</a>, +<a class="el" href="classRtError.html#w9w5">INVALID_USE</a>, +<a class="el" href="classRtError.html#w9w6">DRIVER_ERROR</a>, +<a class="el" href="classRtError.html#w9w7">SYSTEM_ERROR</a>, <br> - <a class="el" href="classRtError.html#w11w8">DRIVER_ERROR</a>, -<a class="el" href="classRtError.html#w11w9">SYSTEM_ERROR</a>, -<a class="el" href="classRtError.html#w11w10">THREAD_ERROR</a> + <a class="el" href="classRtError.html#w9w8">THREAD_ERROR</a> <br> }</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined RtError types. <a href="classRtError.html#w11">More...</a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined RtError types. <a href="classRtError.html#w9">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="RtError::RtError" ref="a0" args="(const std::string &message, Type type=RtError::UNSPECIFIED)" --> - </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#w11">Type</a> type=RtError::UNSPECIFIED)</td></tr> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#w9">Type</a> type=RtError::UNSPECIFIED) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtError::~RtError" ref="a1" args="(void)" --> -virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr> +virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a1">~RtError</a> (void) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="RtError::printMessage" ref="a2" args="(void)" --> -virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a2">printMessage</a> (void) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prints thrown error message to stderr. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="RtError::getType" ref="a3" args="(void)" --> -virtual const <a class="el" href="classRtError.html#w11">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr> +virtual const <a class="el" href="classRtError.html#w9">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3">getType</a> (void) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message type. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="RtError::getMessage" ref="a4" args="(void)" --> -virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr> +virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a4">getMessage</a> (void) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message string. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="RtError::getMessageString" ref="a5" args="(void)" --> -virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a5">getMessageString</a> (void)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="RtError::what" ref="a5" args="(void) const " --> +virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a5">what</a> (void) const throw ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a C string. <br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a c-style string. <br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> & RtMidi. <p> -The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w11">RtError::Type</a>. See the <a class="el" href="classRtAudio.html">RtAudio</a> and RtMidi documentation to know which methods can throw an RtError. +The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w9">RtError::Type</a>. See the <a class="el" href="classRtAudio.html">RtAudio</a> and RtMidi documentation to know which methods can throw an RtError. <p> <hr><h2>Member Enumeration Documentation</h2> -<a class="anchor" name="w11"></a><!-- doxytag: member="RtError::Type" ref="w11" args="" --><p> +<a class="anchor" name="w9"></a><!-- doxytag: member="RtError::Type" ref="w9" args="" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top">enum <a class="el" href="classRtError.html#w11">RtError::Type</a> </td> + <td class="md" nowrap valign="top">enum <a class="el" href="classRtError.html#w9">RtError::Type</a> </td> </tr> </table> </td> @@ -90,27 +89,23 @@ Defined RtError types. <p> <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> -<tr><td valign="top"><em><a class="anchor" name="w11w0"></a><!-- doxytag: member="WARNING" ref="w11w0" args="" -->WARNING</em> </td><td> -A non-critical error. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w1"></a><!-- doxytag: member="DEBUG_WARNING" ref="w11w1" args="" -->DEBUG_WARNING</em> </td><td> -A non-critical error which might be useful for debugging. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w2"></a><!-- doxytag: member="UNSPECIFIED" ref="w11w2" args="" -->UNSPECIFIED</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w0"></a><!-- doxytag: member="UNSPECIFIED" ref="w9w0" args="" -->UNSPECIFIED</em> </td><td> The default, unspecified error type. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w3"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="w11w3" args="" -->NO_DEVICES_FOUND</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w1"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="w9w1" args="" -->NO_DEVICES_FOUND</em> </td><td> No devices found on system. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w4"></a><!-- doxytag: member="INVALID_DEVICE" ref="w11w4" args="" -->INVALID_DEVICE</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w2"></a><!-- doxytag: member="INVALID_DEVICE" ref="w9w2" args="" -->INVALID_DEVICE</em> </td><td> An invalid device ID was specified. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w5"></a><!-- doxytag: member="INVALID_STREAM" ref="w11w5" args="" -->INVALID_STREAM</em> </td><td> -An invalid stream ID was specified. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w6"></a><!-- doxytag: member="MEMORY_ERROR" ref="w11w6" args="" -->MEMORY_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w3"></a><!-- doxytag: member="MEMORY_ERROR" ref="w9w3" args="" -->MEMORY_ERROR</em> </td><td> An error occured during memory allocation. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w7"></a><!-- doxytag: member="INVALID_PARAMETER" ref="w11w7" args="" -->INVALID_PARAMETER</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w4"></a><!-- doxytag: member="INVALID_PARAMETER" ref="w9w4" args="" -->INVALID_PARAMETER</em> </td><td> An invalid parameter was specified to a function. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w8"></a><!-- doxytag: member="DRIVER_ERROR" ref="w11w8" args="" -->DRIVER_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w5"></a><!-- doxytag: member="INVALID_USE" ref="w9w5" args="" -->INVALID_USE</em> </td><td> +The function was called incorrectly. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="w9w6"></a><!-- doxytag: member="DRIVER_ERROR" ref="w9w6" args="" -->DRIVER_ERROR</em> </td><td> A system driver error occured. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w9"></a><!-- doxytag: member="SYSTEM_ERROR" ref="w11w9" args="" -->SYSTEM_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w7"></a><!-- doxytag: member="SYSTEM_ERROR" ref="w9w7" args="" -->SYSTEM_ERROR</em> </td><td> A system error occured. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w10"></a><!-- doxytag: member="THREAD_ERROR" ref="w11w10" args="" -->THREAD_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w9w8"></a><!-- doxytag: member="THREAD_ERROR" ref="w9w8" args="" -->THREAD_ERROR</em> </td><td> A thread error occured. </td></tr> </table> </dl> @@ -122,8 +117,7 @@ A thread error occured. </td></tr> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.<br> - Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr> + <td>©2001-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> </table> </BODY> |