xPCI-3120 API
APCI-3120 DLL ADDI-DATA W32-Bit Driver for x86 General functions

Functions

_INT_ i_APCI3120_InitCompiler (BYTE_ b_CompilerDefine)
 
_INT_ i_APCI3120_CheckAndGetPCISlotNumber (PBYTE_ pb_SlotNumberArray)
 
_INT_ i_APCI3120_GetHardwareInformation (BYTE_ b_BoardHandle, PUINT_ pui_BaseAddress, PBYTE_ pb_InterruptNbr, PBYTE_ pb_SlotNumber)
 
_INT_ i_APCI3120_SetBoardInformation (BYTE_ b_SlotNumberArray, BYTE b_AnalogInputChannelNbr, BYTE b_AnalogOutputChannelNbr, PBYTE_ pb_BoardHandle)
 
_INT_ i_APCI3120_SetBoardInformationViaIdentifer (PCHAR_ pc_Identifier, PBYTE_ ph_DeviceHandle)
 
_INT_ i_APCI3120_CloseBoardHandle (BYTE_ b_BoardHandle)
 

Detailed Description

Function Documentation

◆ i_APCI3120_InitCompiler()

_INT_ i_APCI3120_InitCompiler ( BYTE_  b_CompilerDefine)

This function is only available in a windows environment

Parameters
[in]b_CompilerDefine: Program Language selection.
Return values
0: no error

◆ i_APCI3120_CheckAndGetPCISlotNumber()

_INT_ i_APCI3120_CheckAndGetPCISlotNumber ( PBYTE_  pb_SlotNumberArray)

Check all APCI-3120 and return the slot number of each APCI-3120 board.
| Each pb_SlotNumberArray member contain the slot
number (1 to 8) from 1 APCI-3120 Board.

Parameters
[in]pb_SlotNumberArray: Slot number list.
Return values
>0: Number of boards found
0: No board found
-101: Error while getting the number of boards
-102: Unable to open the board via index
-103: Error when calling driver's IOCTL

◆ i_APCI3120_GetHardwareInformation()

_INT_ i_APCI3120_GetHardwareInformation ( BYTE_  b_BoardHandle,
PUINT_  pui_BaseAddress,
PBYTE_  pb_InterruptNbr,
PBYTE_  pb_SlotNumber 
)

Get device information of the board.

Parameters
[in]b_BoardHandle: Index of the board
[out]pb_SlotNumber: Slot number.
[out]pui_BaseAddress: Base address of the board
[out]pb_InterruptNbr: Interrupt line of the board
Return values
0: No error
-1: Wrong device handle

◆ i_APCI3120_SetBoardInformation()

_INT_ i_APCI3120_SetBoardInformation ( BYTE_  b_SlotNumberArray,
BYTE  b_AnalogInputChannelNbr,
BYTE  b_AnalogOutputChannelNbr,
PBYTE_  pb_BoardHandle 
)

Open board with slot number.

Parameters
[in]b_SlotNumberArray: Index of the board to open
[in]b_AnalogInputChannelNbr: Analog input channel number
[in]b_AnalogOutputChannelNbr: Analog output channel number
[out]pb_BoardHandle: Handle of the selected APCI-3120 board for using the functions
Return values
0: No error
-1: Not available slot number
-101: Unable to get the number of available boards
-103: Error while getting the device's class
-104: Error while getting informations about the device
-105: Memory allocation error
-106: Get device interface detail error
-107: Error while creating communication handle
-108: Error in the initialization callback function
-109: Input Mode is not setted in the device manager

◆ i_APCI3120_SetBoardInformationViaIdentifer()

_INT_ i_APCI3120_SetBoardInformationViaIdentifer ( PCHAR_  pc_Identifier,
PBYTE_  ph_DeviceHandle 
)

Open the board with the indentifier : pc_Identifier. A handle is returned to the

user which allows to use the following functions.

Parameters
[in]pc_Identifier: Identifier of the board to open
[out]ph_DeviceHandle: Handle of the board APCI-3120 for using the functions
Return values
0: No Error
-1: Not available identifier
-101: Unable to get the number of available boards
-102: Unable to get the board identifier
-103: Unable to open the board
-104: Identifier not found
-105: Input Mode is not setted in the device manager

◆ i_APCI3120_CloseBoardHandle()

_INT_ i_APCI3120_CloseBoardHandle ( BYTE_  b_BoardHandle)

Release the handle of the board. Block the access to the board.

Parameters
[in]b_BoardHandle: Handle of the board
Return values
0: No Error
-1: The device handle parameter is wrong