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
Device Information

Retrieve device information. More...

Functions

UlError ulGetInfoStr (UlInfoItemStr infoItem, unsigned int index, char *infoStr, unsigned int *maxConfigLen)
 Use with UlInfoItemStr to retrieve device information as a null-terminated string. More...
 
UlError ulSetConfig (UlConfigItem configItem, unsigned int index, long long configValue)
 Use with UlConfigItem to change device configuration options at runtime. More...
 
UlError ulGetConfig (UlConfigItem configItem, unsigned int index, long long *configValue)
 Returns a configuration option set for the device. More...
 
UlError ulDevGetInfo (DaqDeviceHandle daqDeviceHandle, DevInfoItem infoItem, unsigned int index, long long *infoValue)
 Use with DevInfoItem to retrieve information about the device subsystem to determine which subsystem types are supported for the device. More...
 
UlError ulDevGetConfigStr (DaqDeviceHandle daqDeviceHandle, DevConfigItemStr configItem, unsigned int index, char *configStr, unsigned int *maxConfigLen)
 Use with DevConfigItemStr to retrieve the current configuration as a null-terminated string. More...
 
UlError ulMemGetInfo (DaqDeviceHandle daqDeviceHandle, MemRegion memRegion, MemDescriptor *memDescriptor)
 Use with MemDescriptor to retrieve information about the memory region on a DAQ device. More...
 

Detailed Description

Retrieve device information.

Function Documentation

UlError ulDevGetConfigStr ( DaqDeviceHandle  daqDeviceHandle,
DevConfigItemStr  configItem,
unsigned int  index,
char *  configStr,
unsigned int *  maxConfigLen 
)

Use with DevConfigItemStr to retrieve the current configuration as a null-terminated string.

Parameters
daqDeviceHandlethe handle to the DAQ device
configItemthe configuration item to retrieve from the device
indexspecifies the version type to return as an index into configItem (DevVersionType)
configStrpointer to the buffer where the configuration string is copied
maxConfigLenpointer to the value specifying the size of configStr made available by the user; returns the number of chars written to configStr.
Returns
The UL error code.
UlError ulDevGetInfo ( DaqDeviceHandle  daqDeviceHandle,
DevInfoItem  infoItem,
unsigned int  index,
long long *  infoValue 
)

Use with DevInfoItem to retrieve information about the device subsystem to determine which subsystem types are supported for the device.

Parameters
daqDeviceHandlethe handle to the DAQ device
infoItemthe subsystem information to retrieve
indexignored
infoValuethe subsystem information is returned to this variable
Returns
The UL error code.
UlError ulGetConfig ( UlConfigItem  configItem,
unsigned int  index,
long long *  configValue 
)

Returns a configuration option set for the device.


Use ulSetConfig() to change configuration options.

Parameters
configItemthe configuration item to retrieve
indexthe index into the configItem
configValuethe specified configuration value is returned to this variable
Returns
The UL error code.
UlError ulGetInfoStr ( UlInfoItemStr  infoItem,
unsigned int  index,
char *  infoStr,
unsigned int *  maxConfigLen 
)

Use with UlInfoItemStr to retrieve device information as a null-terminated string.

Parameters
infoItemthe information to read from the device
indexeither ignored or an index into the infoStr
infoStrpointer to the buffer where the information string is copied
maxConfigLenpointer to the value holding the maximum number of bytes to be read from the device into configStr
Returns
The UL error code.
UlError ulMemGetInfo ( DaqDeviceHandle  daqDeviceHandle,
MemRegion  memRegion,
MemDescriptor memDescriptor 
)

Use with MemDescriptor to retrieve information about the memory region on a DAQ device.

Parameters
daqDeviceHandlethe handle to the DAQ device
memRegionthe memory region
memDescriptora MemDescriptor struct containing fields where information is returned, such as memory type and access
Returns
The UL error code.
UlError ulSetConfig ( UlConfigItem  configItem,
unsigned int  index,
long long  configValue 
)

Use with UlConfigItem to change device configuration options at runtime.

Parameters
configItemthe type of information to write to the device
indexeither ignored or an index into the configValue
configValuethe value to set the specified configuration item to
Returns
The UL error code.