Client Enumerations

Enumerations
enum	UVSC_STATUS {   UVSC_STATUS_SUCCESS = 0,   UVSC_STATUS_FAILED = 1,   UVSC_STATUS_NOT_SUPPORTED = 2,   UVSC_STATUS_NOT_INIT = 3,   UVSC_STATUS_TIMEOUT = 4,   UVSC_STATUS_INVALID_CONTEXT = 5,   UVSC_STATUS_INVALID_PARAM = 6,   UVSC_STATUS_BUFFER_TOO_SMALL = 7,   UVSC_STATUS_CALLBACK_IN_USE = 8,   UVSC_STATUS_COMMAND_ERROR = 9,   UVSC_STATUS_END }
enum	UVSC_RUNMODE {   UVSC_RUNMODE_NORMAL = 0,   UVSC_RUNMODE_LABVIEW = 1,   UVSC_RUNMODE_END = 2 }
enum	UVSC_PBAR {   UVSC_PBAR_INIT = 0,   UVSC_PBAR_TEXT = 1,   UVSC_PBAR_POS = 2,   UVSC_PBAR_STOP = 3 }
enum	UVSC_CB_TYPE {   UVSC_CB_ERROR = 0,   UVSC_CB_ASYNC_MSG = 1,   UVSC_CB_DISCONNECTED = 2,   UVSC_CB_BUILD_OUTPUT_MSG = 3,   UVSC_CB_PROGRESS_BAR_MSG = 4,   UVSC_CB_CMD_OUTPUT_MSG = 5 }

Description

Enumeration Type Documentation

enum UVSC_CB_TYPE

UVSC callback type

Indicates the type of message retuned in the UVSC callback function uvsc_cb configured through UVSC_OpenConnection.

Enumerator
UVSC_CB_ERROR	Error notification (not used)
UVSC_CB_ASYNC_MSG	Asynchronous message received (called from UVSC internal thread)
UVSC_CB_DISCONNECTED	uVision has disconnected (called from UVSC internal thread)
UVSC_CB_BUILD_OUTPUT_MSG	Called from the UVSC_PRJ_BUILD function - indicates a line of build output (called from API function callers own thread)
UVSC_CB_PROGRESS_BAR_MSG	Called from function that cause a progress bar in uVision - indicates the progress bar state (called from API function callers own thread)
UVSC_CB_CMD_OUTPUT_MSG	Called from the UVSC_DBG_EXEC_CMD function - indicates a line of command output (called from API function callers own thread)

enum UVSC_PBAR

Progress bar operations

Progress bar operations as returned by UVSC_ReadPBarQ.

Enumerator
UVSC_PBAR_INIT	Initialise progress bar.
UVSC_PBAR_TEXT	Set progress bar text.
UVSC_PBAR_POS	Set progress bar position.
UVSC_PBAR_STOP	Stop progress bar.

enum UVSC_RUNMODE

uVision Runmode

Indicates the mode uVision will be started in if it is auto-started.

Enumerator
UVSC_RUNMODE_NORMAL	Normal uVision operation.
UVSC_RUNMODE_LABVIEW	LabVIEW operation.
UVSC_RUNMODE_END	Always at end.

enum UVSC_STATUS

UVSC status codes

UVSC status codes are returned by UVSC API functions, and indicate the success or failure of the called API function.

Enumerator
UVSC_STATUS_SUCCESS	Success.
UVSC_STATUS_FAILED	General failure.
UVSC_STATUS_NOT_SUPPORTED	Request for an unsupported operation.
UVSC_STATUS_NOT_INIT	UVSC not initialised.
UVSC_STATUS_TIMEOUT	Operation timed-out.
UVSC_STATUS_INVALID_CONTEXT	Function called from an invalid context (most likely the callback function)
UVSC_STATUS_INVALID_PARAM	Function called with one or more invalid parameters.
UVSC_STATUS_BUFFER_TOO_SMALL	Function called with a buffer that was not big enough to hold the result from uVision.
UVSC_STATUS_CALLBACK_IN_USE	Function cannot be used when the callback is in use.
UVSC_STATUS_COMMAND_ERROR	The command failed - call UVSC_GetLastError to get more information on how the command failed.
UVSC_STATUS_END	Always at end.