Group cuvis_returns

Public Types

Type	Name
enum	cuvis_status_t return state of any SDK function

Public Functions

Type	Name
SDK_CAPI const CUVIS_CHAR *SDK_CCALL	cuvis_get_last_error_msg (void)
SDK_CAPI const CUVIS_WCHAR *SDK_CCALL	cuvis_get_last_error_msg_localized (void)
SDK_CAPI const CUVIS_STATUS SDK_CCALL	cuvis_set_last_error_locale (CUVIS_CHAR const * i_locale_id)

Detailed Description

More Information on the Return Values of the SDK Functions.

Most of the SDK functions return a cuvis_status_t. This value indicates if the function call was executed sucessfully or if a error occurred. If the value is status_error for example, this indicates that an error occurred. The specific error message can then be retrieved via cuvis_get_last_error_msg to get more details.

Public Types Documentation

enum cuvis_status_t

return state of any SDK function

enum cuvis_status_t {
    status_ok = 1,
    status_error = -1,
    status_deferred = -10,
    status_overwritten = -11,
    status_timeout = -12,
    status_no_measurement = -20,
    status_not_available = -30,
    status_not_processed = -41,
    status_not_stored = -42,
    status_no_view = -43
};

Public Functions Documentation

function cuvis_get_last_error_msg

SDK_CAPI const CUVIS_CHAR * SDK_CCALL cuvis_get_last_error_msg (
    void
)

Call this function for obtaining the last error message

function cuvis_get_last_error_msg_localized

SDK_CAPI const CUVIS_WCHAR * SDK_CCALL cuvis_get_last_error_msg_localized (
    void
)

Call this function for obtaining the last localized error message

remember to set locale with cuvis_set_last_error_locale first.

function cuvis_set_last_error_locale

SDK_CAPI const CUVIS_STATUS  SDK_CCALL cuvis_set_last_error_locale (
    CUVIS_CHAR const * i_locale_id
)

Set the locale for localized error messages

Parameters:

i_locale_id set the locale id, e.g. "de" for german. See the "locale" directory for available translations.