UL for Linux
A user library to access supported MCC hardware in Linux
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Miscellaneous

Miscellaneous functions. More...

Functions

UlError ulFlashLed (DaqDeviceHandle daqDeviceHandle, int flashCount)
 Causes the LED on a DAQ device to flash. More...
 
UlError ulEnableEvent (DaqDeviceHandle daqDeviceHandle, DaqEventType eventTypes, unsigned long long eventParameter, DaqEventCallback eventCallbackFunction, void *userData)
 Binds one or more event conditions to a DaqEventCallback function. More...
 
UlError ulDisableEvent (DaqDeviceHandle daqDeviceHandle, DaqEventType eventTypes)
 Disables one or more event conditions, and disconnects their user-defined handlers. More...
 
UlError ulMemRead (DaqDeviceHandle daqDeviceHandle, MemRegion memRegion, unsigned int address, unsigned char *buffer, unsigned int count)
 Reads a value read from a specified region in memory; use with ulMemGetInfo() to retrieve information about the memory region on a DAQ device. More...
 
UlError ulMemWrite (DaqDeviceHandle daqDeviceHandle, MemRegion memRegion, unsigned int address, unsigned char *buffer, unsigned int count)
 Writes a value to a specified region in memory. More...
 
UlError ulGetErrMsg (UlError errCode, char errMsg[ERR_MSG_LEN])
 Returns the error message associated with an error code. More...
 

Detailed Description

Miscellaneous functions.

Function Documentation

UlError ulDisableEvent ( DaqDeviceHandle  daqDeviceHandle,
DaqEventType  eventTypes 
)

Disables one or more event conditions, and disconnects their user-defined handlers.

Parameters
daqDeviceHandlethe handle to the DAQ device
eventTypesa bitmask containing event conditions that can be OR'd together; OR all event types to disable all events
Returns
The UL error code.
UlError ulEnableEvent ( DaqDeviceHandle  daqDeviceHandle,
DaqEventType  eventTypes,
unsigned long long  eventParameter,
DaqEventCallback  eventCallbackFunction,
void *  userData 
)

Binds one or more event conditions to a DaqEventCallback function.

Upon detection of an event condition, DaqEventCallback is invoked.

Parameters
daqDeviceHandlethe handle to the DAQ device
eventTypesa bitmask containing event conditions that can be OR'd together
eventParameteradditional data that specifies an event condition, such as the number of data points at which to invoke DE_ON_DATA_AVAILABLE
eventCallbackFunctionthe pointer to the user-defined callback function to handle event conditions.
userDatathe pointer to the data that will be passed to the callback function
Returns
The UL error code.
UlError ulFlashLed ( DaqDeviceHandle  daqDeviceHandle,
int  flashCount 
)

Causes the LED on a DAQ device to flash.

Parameters
daqDeviceHandlethe handle to the DAQ device
flashCountThe number of flashes; set to 0 for a continuous flash until the next call with a non-zero value
Returns
The UL error code.
UlError ulGetErrMsg ( UlError  errCode,
char  errMsg[ERR_MSG_LEN] 
)

Returns the error message associated with an error code.

Parameters
errCodethe error code returned from a Universal Library function to translate into an error message
errMsgthe error message associated with the code provided is returned here. The constant ERR_MSG_LEN is set to a value such that the buffer is large enough to contain the longest error message.
Returns
The UL error code.
UlError ulMemRead ( DaqDeviceHandle  daqDeviceHandle,
MemRegion  memRegion,
unsigned int  address,
unsigned char *  buffer,
unsigned int  count 
)

Reads a value read from a specified region in memory; use with ulMemGetInfo() to retrieve information about the memory region on a DAQ device.

Parameters
daqDeviceHandlethe handle to the DAQ device
memRegionmemory region
addressmemory address
bufferpointer to the buffer where the value read will be stored
countthe size of the buffer that the user made available to store the value returned
Returns
The UL error code.
UlError ulMemWrite ( DaqDeviceHandle  daqDeviceHandle,
MemRegion  memRegion,
unsigned int  address,
unsigned char *  buffer,
unsigned int  count 
)

Writes a value to a specified region in memory.

Parameters
daqDeviceHandlethe handle to the DAQ device
memRegionmemory region
addressmemory address
bufferpointer to the buffer provided by the user containing the value to write
countnumber or data points to read; must be equal to or less than the size of the buffer created by the user containing the value to write
Returns
The UL error code.