AlazarGetParameter#

Function Syntax#

RETURN_CODE AlazarGetParameter(HANDLE handle, U8 channel, U32 parameter, long *retValue)#

Get a device parameter as a signed long value.

Parameters:

handle – [in] Board handle
channel – [in] The channel to control. See ALAZAR_CHANNELS for a list of possible values. This parameter only takes unsigned 8-bit values.
parameter – [in] The Parameter to modify. This can be one of ALAZAR_PARAMETERS.
retValue – [in] Parameter’s value

Returns:

ApiSuccess upon success, or an error code. See RETURN_CODE for more detailed information.

LabVIEW Block Diagram#

Related Enumerations#

enum ALAZAR_PARAMETERS#

Parameters suitable to be used with AlazarSetParameter() and/or AlazarGetParameter()

Values:

enumerator DATA_WIDTH#: The number of bits per sample.

enumerator SETGET_ASYNC_BUFFSIZE_BYTES#: The size of API-allocated DMA buffers in bytes.

enumerator SETGET_ASYNC_BUFFCOUNT#: The number of API-allocated DMA buffers.

enumerator GET_ASYNC_BUFFERS_PENDING#: DMA buffers currently posted to the board.

enumerator GET_ASYNC_BUFFERS_PENDING_FULL#: DMA buffers waiting to be processed by the application.

enumerator GET_ASYNC_BUFFERS_PENDING_EMPTY#: DMA buffers waiting to be filled by the board.

enumerator SET_DATA_FORMAT#: 0 if the data format is unsigned, and 1 otherwise

enumerator GET_DATA_FORMAT#: 0 if the data format is unsigned, and 1 otherwise

enumerator GET_SAMPLES_PER_TIMESTAMP_CLOCK#: Number of samples per timestamp clock.

enumerator GET_RECORDS_CAPTURED#: Records captured since the start of the acquisition (single-port) or buffer (dual-port)

enumerator ECC_MODE#: ECC mode. Member of ALAZAR_ECC_MODES.

enumerator GET_AUX_INPUT_LEVEL#: Read the TTL level of the AUX connector. Member of ALAZAR_AUX_INPUT_LEVELS

enumerator GET_CHANNELS_PER_BOARD#: Number of analog channels supported by this digitizer.

enumerator GET_FPGA_TEMPERATURE#

Current FPGA temperature in degrees Celcius. Only supported by PCIe digitizers. Please note that the returned value is encoded in a 32-bit floating point number. The following code sample demonstrates how to get the temperature value.

float temperature_c;
RETURN_CODE rc = AlazarGetParameter(board, 0, GET_FPGA_TEMPERATURE, (long*)&temperature_c);
if (rc != ApiSuccess) {
  // Handle error
}

enumerator PACK_MODE#: Get/Set the pack mode as a member of ALAZAR_PACK_MODES.

enumerator SET_SINGLE_CHANNEL_MODE#: Reserve all the on-board memory to the channel passed as argument. Single-port only.

enumerator API_FLAGS#: Get/Set the state of the API logging as a member of ALAZAR_API_TRACE_STATES

enumerator SET_SOFTWARE_CAL_MECHANISM#: Use software calibration mechanism if set to 1, else use standard hardware calibration.

enumerator API_LOG_CLEAR#: Clear the log file of the API logging mechanism.

enumerator SETGET_TRIGGER_SKIPPING#: Sets of gets the current value of trigger skipping. Please refer to the trigger skipping section of the documentation for more information.

enumerator GET_ADC_TEMPERATURE#

Current ADC temperature in degrees Celcius. Only supported by PCIe digitizers. Please note that the returned value is encoded in a 32-bit floating point number. The following code sample demonstrates how to get the temperature value.

float temperature_c;
RETURN_CODE rc = AlazarGetParameter(board, 0, GET_ADC_TEMPERATURE, (long*)&temperature_c);
if (rc != ApiSuccess) {
  // Handle error
}

enumerator GET_ONBOARD_MEMORY_USED#: Get the percentage of on-board memory used. Feature only supported for certain board types.

enum ALAZAR_ECC_MODES#

ECC Modes.

Values:

enumerator ECC_DISABLE#: Disable.

enumerator ECC_ENABLE#: Enable.

enum ALAZAR_AUX_INPUT_LEVELS#

Auxiliary input levels.

Values:

enumerator AUX_INPUT_LOW#: Low level.

enumerator AUX_INPUT_HIGH#: High level.

enum ALAZAR_PACK_MODES#

Data pack modes.

Values:

enumerator PACK_DEFAULT#: Default pack mode of the board.

enumerator PACK_8_BITS_PER_SAMPLE#: 8 bits per sample

enumerator PACK_12_BITS_PER_SAMPLE#: 12 bits per sample

enum ALAZAR_API_TRACE_STATES#

API trace states.

Values:

enumerator API_DISABLE_TRACE#: Trace disabled.

enumerator API_ENABLE_TRACE#: Trace enabled.