.TH "SoReadError" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoReadError \- The \fBSoReadError\fP class is used during model import operations\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/errors/SoReadError\&.h>\fP
.PP
Inherits \fBSoError\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoError\fP ()"
.br
.ti -1c
.RI "const \fBSbString\fP & \fBgetDebugString\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (const \fBSoType\fP type) const"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBsetHandlerCallback\fP (SoErrorCB *const function, void *const data)"
.br
.ti -1c
.RI "static SoErrorCB * \fBgetHandlerCallback\fP (void)"
.br
.ti -1c
.RI "static void * \fBgetHandlerData\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBpost\fP (const \fBSoInput\fP *const input, const char *const format,\&.\&.\&.)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "static void \fBsetHandlerCallback\fP (SoErrorCB *const func, void *const data)"
.br
.ti -1c
.RI "static SoErrorCB * \fBgetHandlerCallback\fP (void)"
.br
.ti -1c
.RI "static void * \fBgetHandlerData\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBpost\fP (const char *const format,\&.\&.\&.)"
.br
.ti -1c
.RI "static \fBSbString\fP \fBgetString\fP (const \fBSoNode\fP *const node)"
.br
.ti -1c
.RI "static \fBSbString\fP \fBgetString\fP (const \fBSoPath\fP *const path)"
.br
.ti -1c
.RI "static \fBSbString\fP \fBgetString\fP (const \fBSoEngine\fP *const engine)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClasses\fP (void)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual SoErrorCBPtr \fBgetHandler\fP (void *&data) const"
.br
.in -1c

Protected Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "void \fBsetDebugString\fP (const char *const str)"
.br
.ti -1c
.RI "void \fBappendToDebugString\fP (const char *const str)"
.br
.ti -1c
.RI "void \fBhandleError\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"


Static Protected Member Functions inherited from \fBSoError\fP
.in +1c
.ti -1c
.RI "static void \fBdefaultHandlerCB\fP (const \fBSoError\fP *error, void *userdata)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoReadError\fP class is used during model import operations\&. 

During model file import, this class will be used to output any error or warning messages\&.

.PP
Depending on your application, setting up your own error handler callbacks for \fBSoReadError\fP might be a good idea\&. 
.SH "Member Function Documentation"
.PP 
.SS "void SoReadError::setHandlerCallback (SoErrorCB *const function, void *const data)\fR [static]\fP"
This method sets the error handler callback for messages posted via this class\&.

.PP
Note that this will not override the error/debug message handler for subclasses, these will have to be overridden by calling the subclass' \fBsetHandlerCallback()\fP method\&.

.PP
\fBSee also\fP
.RS 4
\fBdefaultHandlerCB()\fP    
.RE
.PP

.SS "SoErrorCB * SoReadError::getHandlerCallback (void )\fR [static]\fP"
Returns the error handler callback for messages posted via this class\&.    
.SS "void * SoReadError::getHandlerData (void )\fR [static]\fP"
This method returns the pointer used for passing data back to the callback handler method\&.    
.SS "\fBSoType\fP SoReadError::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP for this class\&.

.PP
\fBSee also\fP
.RS 4
\fBgetTypeId()\fP    
.RE
.PP

.SS "\fBSoType\fP SoReadError::getTypeId (void ) const\fR [virtual]\fP"
This method returns the \fBSoType\fP of a particular object instance\&.

.PP
\fBSee also\fP
.RS 4
\fBgetClassTypeId()\fP 
.RE
.PP

.PP
Reimplemented from \fBSoError\fP\&.
.SS "void SoReadError::post (const \fBSoInput\fP *const in, const char *const format,  \&.\&.\&.)\fR [static]\fP"
Method used from import code to post error or warning messages for model files which are not 100% compliant to the format specification\&.

.PP
The messages will be wrapped within information on line number, file offset etc\&. 
.SS "SoErrorCB * SoReadError::getHandler (void *& data) const\fR [protected]\fP, \fR [virtual]\fP"
This is just a convenience wrapper around the \fBgetHandlerCallback()\fP and \fBgetHandlerData()\fP methods\&. 
.PP
Reimplemented from \fBSoError\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.