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

daqDeviceHandle	the handle to the DAQ device
eventTypes	a 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

daqDeviceHandle	the handle to the DAQ device
eventTypes	a bitmask containing event conditions that can be OR'd together
eventParameter	additional data that specifies an event condition, such as the number of data points at which to invoke DE_ON_DATA_AVAILABLE
eventCallbackFunction	the pointer to the user-defined callback function to handle event conditions.
userData	the 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

daqDeviceHandle	the handle to the DAQ device
flashCount	The 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

errCode	the error code returned from a Universal Library function to translate into an error message
errMsg	the 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

daqDeviceHandle	the handle to the DAQ device
memRegion	memory region
address	memory address
buffer	pointer to the buffer where the value read will be stored
count	the 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

daqDeviceHandle	the handle to the DAQ device
memRegion	memory region
address	memory address
buffer	pointer to the buffer provided by the user containing the value to write
count	number 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.