ProSoft Technology MVI69-ADM - Manual (Page 225)

MVI-ADM ♦ 'C' Programmable Backplane API Functions
'C' Programmable Application Development Module Developer's Guide
ProSoft Technology, Inc. Page 225 of 342
February 20, 2013
MVIbp_GetConsoleMode
Syntax
int MVIbp_GetConsoleMode(MVIHANDLE handle, int *mode, int *baud);
Parameters
handle Handle returned by previous call to MVIbp_Open
mode Pointer to an integer that is set to 1 if the console is installed, or 0
if the console is not enabled.
baud Pointer to an integer that is set to the console baud rate index if
the console is enabled.
Description
This function queries the state of the console.
handle must be a valid handle returned from MVIbp_Open.
mode is a pointer to an integer. When this function returns, mode will be set to 1
if the console is enabled, or 0 if the console is disabled.
baud is a pointer to an integer. When this function returns, baud will be set to the
console’s baud index value if the console is enabled. baud is not set if the
console is disabled.
It may be useful for an application to detect that the console is enabled and allow
user interaction.
Note: If the Setup Jumper is installed, the console is enabled at 19200 baud.
Return Value
MVI_SUCCESS No errors were encountered
MVI_ERR_NOACCESS handle does not have access
Example
MVIHANDLE handle;
int mode;
MVIbp_GetConsoleMode(handle, &mode);
if (mode)
// Console is enabled - allow user interaction
else
// Console is not available - normal operation