2. Errors and Warnings#
2.1. rsGetLastError#
Returns a string describing the most recent error.
2.1.1. Syntax#
S = rsGetLastError()
2.1.2. Description#
- S = rsGetLastError()
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. rsSetWarningMode#
Enables/disables automatic printing of warnings.
2.2.1. Syntax#
rsSetWarningMode(N)
2.2.2. Description#
- rsSetWarningMode(N)
enables or disables automatic printing of warning messages.
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 rsGetNumWarnings will always return 0 and rsGetNextWarning will always return an empty string.
If N=0, then warnings will not be printed but will be stored for retrieval via the rsGetNextWarning function.
2.2.3. See Also#
2.3. rsGetNextWarning#
Returns a string describing the next unread warning.
2.3.1. Syntax#
S = rsGetNextWarning()
2.3.2. Description#
- S = rsGetNextWarning()
returns a string S describing the oldest unread stored warning that occurred during a Reactis API function call. Returns an empty string if no warnings remain. If warnings were dropped (see function rsSetMaxNumWarnings) then the returned string will be a message indicating the number of warnings that have been dropped.
2.3.3. See Also#
rsSetWarningMode, rsGetNumWarnings, rsClearWarnings, rsSetMaxNumWarnings
2.4. rsGetNumWarnings#
Returns the number of unread warnings.
2.4.1. Syntax#
N = rsGetNumWarnings()
2.4.2. Description#
- N = rsGetNumWarnings()
returns the number of unread stored warnings received during execution of Reactis API functions. Note that dropped warnings are still included in this count and therefore the value returned by rsGetNumWarnings() may exceed the maximum number set using rsSetMaxNumWarnings.
2.4.3. See Also#
2.5. rsClearWarnings#
Clears all currently stored warnings.
2.5.1. Syntax#
rsClearWarnings()
2.5.2. Description#
- rsClearWarnings()
clears all unread warnings that were produced during previous API calls.
2.5.3. See Also#
2.6. rsSetMaxNumWarnings#
Sets the maximum number of warnings stored.
2.6.1. Syntax#
rsSetMaxNumWarnings(N)
2.6.2. Description#
- rsSetMaxNumWarnings(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 rsGetNextWarning() will return a message indicating the number of warnings that were dropped. Subsequent calls to rsGetNextWarning() will return the remaining warnings.
If the maximum number is set to 0, then no warnings will be stored. Calls to rsGetNextWarning 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.