X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fhtml%2FclassRtError.html;fp=doc%2Fhtml%2FclassRtError.html;h=244c52f5e999e2f8f3287f33dd41789b32fbe93d;hb=0876bbd0bad22677b23342c828bc36c3babbed4e;hp=23bfd0f2e388c47e21de04bcfc71d56e9fb31bfa;hpb=332b0956ae798ea52073fe5b889696a33e0f11f2;p=rtaudio.git 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 @@ -The RtAudio Tutorial +The RtAudio Home Page +
-Tutorial   Class/Enum List   File List   Compound Members  
+Home   Class/Enum List   File List   Compound Members  

RtError Class Reference

Exception handling class for RtAudio & RtMidi. @@ -16,63 +17,61 @@ List of all members. - - + +  +virtual  +virtual void  +virtual const Type &  +virtual const std::string &  - + - +

Public Types

enum  Type {
-  WARNING, -DEBUG_WARNING, -UNSPECIFIED, -NO_DEVICES_FOUND, +
enum  Type {
+  UNSPECIFIED, +NO_DEVICES_FOUND, +INVALID_DEVICE, +MEMORY_ERROR,
-  INVALID_DEVICE, -INVALID_STREAM, -MEMORY_ERROR, -INVALID_PARAMETER, +  INVALID_PARAMETER, +INVALID_USE, +DRIVER_ERROR, +SYSTEM_ERROR,
-  DRIVER_ERROR, -SYSTEM_ERROR, -THREAD_ERROR +  THREAD_ERROR
}
 Defined RtError types. More...
 Defined RtError types. More...

Public Member Functions

- RtError (const std::string &message, Type type=RtError::UNSPECIFIED)
RtError (const std::string &message, Type type=RtError::UNSPECIFIED) throw ()
 The constructor.
-virtual ~RtError (void)
~RtError (void) throw ()
 The destructor.
-virtual void printMessage (void)
printMessage (void) throw ()
 Prints thrown error message to stderr.
-virtual const Type & getType (void)
getType (void) throw ()
 Returns the thrown error message type.
-virtual const std::string & getMessage (void)
getMessage (void) throw ()
 Returns the thrown error message string.
-virtual const char * getMessageString (void)
+virtual const char * what (void) const throw ()
 Returns the thrown error message as a C string.
 Returns the thrown error message as a c-style string.

Detailed Description

Exception handling class for RtAudio & RtMidi.

-The RtError class is quite simple but it does allow errors to be "caught" by RtError::Type. See the RtAudio 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 RtError::Type. See the RtAudio and RtMidi documentation to know which methods can throw an RtError.

Member Enumeration Documentation

-

+

@@ -90,27 +89,23 @@ Defined RtError types.

Enumerator:
- +
enum RtError::Type enum RtError::Type
- - - - - - - - - + - -
WARNING  -A non-critical error.
DEBUG_WARNING  -A non-critical error which might be useful for debugging.
UNSPECIFIED  +
UNSPECIFIED  The default, unspecified error type.
NO_DEVICES_FOUND  +
NO_DEVICES_FOUND  No devices found on system.
INVALID_DEVICE  +
INVALID_DEVICE  An invalid device ID was specified.
INVALID_STREAM  -An invalid stream ID was specified.
MEMORY_ERROR  +
MEMORY_ERROR  An error occured during memory allocation.
INVALID_PARAMETER  +
INVALID_PARAMETER  An invalid parameter was specified to a function.
DRIVER_ERROR  +
INVALID_USE  +The function was called incorrectly.
DRIVER_ERROR  A system driver error occured.
SYSTEM_ERROR  +
SYSTEM_ERROR  A system error occured.
THREAD_ERROR  +
THREAD_ERROR  A thread error occured.
@@ -122,8 +117,7 @@ A thread error occured.

- +
©2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.
- Maintained by Gary P. Scavone, gary@music.mcgill.ca
©2001-2007 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.