OpenVSPAPI  3.20.0
Public Member Functions | List of all members
ErrorObj Class Reference

A class for representing API Errors. More...

#include <openvsp_as.h>

Public Member Functions

ERROR_CODE GetErrorCode ()
 
string GetErrorString ()
 

Detailed Description

ErrorObj is defined by an error code enum and associated error string.

Definition at line 987 of file openvsp_as.h.

Member Function Documentation

◆ GetErrorCode()

ERROR_CODE ErrorObj::GetErrorCode ( )

Get the ERROR_CODE enum of the last raised error

if ( err.GetErrorCode() != VSP_CANT_FIND_PARM ) { Print( "---> Error: API PopLast" ); }
See also
ERROR_CODE
Returns
ERROR_CODE error code enum

◆ GetErrorString()

string ErrorObj::GetErrorString ( )

Get the error string of the last raised error

//==== Check For API Errors ====//
while ( GetNumTotalErrors() > 0 )
{
}
Returns
Error string

The documentation for this class was generated from the following file:
ErrorObj::GetErrorCode
ERROR_CODE GetErrorCode()
ErrorObj::GetErrorString
string GetErrorString()
VSP_CANT_FIND_PARM
Definition: openvsp_as.h:1342
GetNumTotalErrors
int GetNumTotalErrors()
PopLastError
ErrorObj PopLastError()
Print
void Print(const string &in data, bool new_line=true)
ErrorObj
A class for representing API Errors.
Definition: openvsp_as.h:987