Publication 1756-RM004B-EN-P - October 2000
MVI Backplane API 3-5
MVI Backplane API
Functions
This section provides detailed programming information for each of the
MVI Backplane API library functions. The calling convention for each
API function is shown in C format. The API library routines are
categorized by functionality as shown in table 3.D.
Table 3.D - MVI Backplane API Functions
Function Category Function Name Description
Initialization MVIbp_Open Initialize access to the API Initialization
MVIbp_Close Terminate access to the API
Configuration MVIbp_GetIOConfig Get the I/O configuration of the module Configuration
MVIbp_SetIOConfig Set the I/O configuration of the module
Direct I/O Access MVIbp_ReadOutputImage Read data from the output image Direct I/O Access
MVIbp_WriteInputImage Write data to the input image
Messaging MVIbp_ReceiveMessage Retrieve a message sent to the module Messaging
MVIbp_SendMessage Send a message
Synchronization MVIbp_WaitForInputScan Wait for input data read (not supported)
MVIbp_WaitForOutputScan Wait for output data update
Miscellaneous MVIbp_GetVersionInfo Get the MVI API version information
MVIbp_GetModuleInfo Get the information for this module
MVIbp_GetProcessorStatus Get the current processor status
MVIbp_GetSetupMode Get the state of the Setup jumper
MVIbp_GetConsoleMode Get the state of the console
MVIbp_SetModuleStatus Set module status to OK or Faulted
MVIbp_SetUserLED Turn the user LED indicators on and off
MVIbp_ErrorString Get a text description for an error code
MVIbp_Sleep Suspend calling task for specified time