ProSoft Technology MVI69-ADM - Manual (Page 229)

MVI-ADM ♦ 'C' Programmable Backplane API Functions
'C' Programmable Application Development Module Developer's Guide
ProSoft Technology, Inc. Page 229 of 342
February 20, 2013
MVIbp_SetConsoleMode
Syntax
int MVIbp_SetConsoleMode(MVIHANDLE handle, int mode, int baud);
Parameters
handle Handle returned by previous call to MVIbp_Open
mode An integer that is set to 1 if the console is to be enabled, or 0 if
the console is not enabled.
baud An integer that is set to the desired console baud rate index if the
console is enabled.
Description
This function sets the state of the console.
handle must be a valid handle returned from MVIbp_Open.
mode is an integer that contains the desired state of the console. mode should
be set to 1 if the console is to be enabled, or 0 if the console is to be disabled.
baud is an integer that contains the desired baud rate of the console. baud
should be set to the console’s baud index value if the console is enabled. The
baud index values are shown in Table 3.
The state of the console is normally configured with the BIOS setup menu and is
saved in battery-backed memory. If the module is removed from power for a
period of time and the battery discharges, then the state information is lost. This
function allows an application to store a desired console state into the battery-
backed memory. Note that the new console state does not take effect until the
MVI46 is rebooted.
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,baud;
mode = 1; // enable the console
baud = 8; // set baud rate to 19200 baud
MVIbp_SetConsoleMode(handle, mode, baud);