2. Errors and Warnings#
2.1. rcGetLastError#
Returns a string describing the most recent error.
2.1.1. Syntax#
S = rcGetLastError()
2.1.2. Description#
- S = rcGetLastError()
returns a string S describing the most recent error that occurred during a Reactis API function call. An empty string is returned when there are no errors.
2.2. rcSetWarningMode#
Enables/Disables automatic printing of warnings.
2.2.1. Syntax#
rcSetWarningMode(N)
2.2.2. Description#
- rcSetWarningMode(N)
enables or disables automatic printing of warning message.
If N=1 (default setting), then any warnings generated during an API call will automatically be printed to the MATLAB command window. The printed warnings are also removed from the list of stored warnings. In this mode, calling rcGetNumWarnings() will always return 0 and rcGetNextWarning() will always return an empty string.
If N=0, then warnings will not be printed but will be stored for retrieval via the rcGetNextWarning() function.
2.2.3. See Also#
2.3. rcGetNextWarning#
Returns a string describing the next unread warning.
2.3.1. Syntax#
S = rcGetNextWarning()
2.3.2. Description#
- S = rcGetNextWarning()
returns a string S describing the next (oldest) unread warning that occurred during a Reactis API function call.
Returns an empty string if no warnings remain.
2.3.3. See Also#
2.4. rcGetNumWarnings#
Returns the number of unread warnings.
2.4.1. Syntax#
N = rcGetNumWarnings()
2.4.2. Description#
- N = rcGetNumWarnings()
returns the number of unread warnings received during execution of Reactis API functions.
2.4.3. See Also#
2.5. rcClearWarnings#
Clears all currently stored warnings.
2.5.1. Syntax#
rcClearWarnings()
2.5.2. Description#
- rcClearWarnings()
clears all unread warnings that were produced during previous API calls.
2.5.3. See Also#
2.6. rcSetMaxNumWarnings#
Sets the maximum number of warnings stored.
2.6.1. Syntax#
rcSetMaxNumWarnings(N)
2.6.2. Description#
- rcSetMaxNumWarnings(N)
sets the maximum number of warnings that the API will store for retrieval. If the number of unread warnings exceeds the number set here then the oldest warnings will be dropped. In that case the next call to rcGetNextWarning() will return a message indicating the number of warnings that were dropped. Subsequent calls to rcGetNextWarning() will return the remaining warnings.
If the maximum number is set to 0, then no warnings will be stored. Calls to rcGetNextWarning will still return a message showing the number of warnings that were produced (and dropped).
If the maximum number is set to -1, then all warnings will be stored. Note that in some cases this can lead to excessive memory usage.
Default setting is to store 200 warnings.