Sensoray 2246 - Manual (Page 28)

MID2246_API int SN_GetVersion (char ** sMid2246Version, char ** sFPGA2246Version, int
* pBoardId, int board)
Get middleware version number and FPGA version number.
Parameters:
sMid2246Version String pointer set to mid2246 middleware version.
sFPGA2246Version String pointer set to 2246 FPGA version.
pBoardId Pointer to integer receiving value of:
• S2246_BOARD_A for Board Rev A-G
• S2246_BOARD_H for Board Rev H-J
• S2246_BOARD_K for Board Rev K-L
board ID if multiple boards installed.
Returns:
0 on success
MID2246_API int SN_Initialize (HWND hwnd, HWND messageHwnd, int removeMsg, int
board)
Opens and Initializes the middleware.
Parameters:
hwnd pointer to window in which to display video
messageHwnd call back window when device removed. removeMsg is sent when device
removed(unplug USB cable unexpectantly). set to NULL is not wanted.
removeMsg value of remove message to send when device removed. see TestDeviceRemove
below and demo app for usage of the remove message
board ID if multiple boards installed.
Returns:
0 on success
MID2246_API int SN_Shutdown (int board)
Cleans up and shuts down the API gracefully
Parameters:
board A -1 indicates all boards will be closed.
Returns:
0 on success
MID2246_API int SN_UpdateClippingWindow (HWND hwnd, int board)
Update the clipping window for the video
Parameters:
hwnd pointer to video display window
board ID if multiple boards installed.
Returns:
0 on success
MID2246_API int SN_SetVideoPosition (int xpos, int ypos, int xsize, int ysize, int left_clip,
int top_clip, int right_clip, int bottom_clip, int board)
Set the video position in the clipping window
28