AlazarErrorToText

Function Syntax

const char *AlazarErrorToText(RETURN_CODE retCode)

Converts a numerical return code to a NULL terminated string.

Remark

It is often easier to work with a descriptive error name than an error number.

Parameters

• retCode – [in] Return code from an AlazarTech API function

Returns

A string containing the identifier name of the error code

LabVIEW Block Diagram

Related Enumerations

enum RETURN_CODE

API functions return codes.

Values:

enumerator ApiSuccess

512 - The operation completed without error

enumerator ApiFailed

The operation failed.

enumerator ApiAccessDenied

Access denied.

enumerator ApiDmaChannelUnavailable

Channel selection is unavailable.

enumerator ApiDmaChannelInvalid

Channel selection in invalid.

enumerator ApiDmaChannelTypeError

Channel selection is invalid.

enumerator ApiDmaInProgress

A data transfer is in progress. This error code indicates that the current action cannot be performed while an acquisition is in progress. It also returned by AlazarPostAsyncBuffer() if this function is called with an invalid DMA buffer.

enumerator ApiDmaDone

DMA transfer is finished.

enumerator ApiDmaPaused

DMA transfer was paused.

enumerator ApiDmaNotPaused

DMA transfer is not paused.

enumerator ApiDmaCommandInvalid

A DMA command is invalid.

enumerator ApiNullParam

One of the parameters of the function is NULL and should not be.

enumerator ApiUnsupportedFunction

This function is not supported by the API. Consult the manual for more information.

enumerator ApiInvalidPciSpace

Invalid PCI space.

enumerator ApiInvalidIopSpace

Invalid IOP space.

enumerator ApiInvalidSize

Invalid size passed as argument to the function.

enumerator ApiInvalidAddress

Invalid address.

enumerator ApiInvalidAccessType

Invalid access type requested.

enumerator ApiInvalidIndex

Invalid index.

enumerator ApiInvalidRegister

Invalid register.

enumerator ApiConfigAccessFailed

Access for configuration failed.

enumerator ApiInvalidDeviceInfo

Invalid device information.

enumerator ApiNoActiveDriver

No active driver for the board. Please ensure that a driver is installed.

enumerator ApiInsufficientResources

There were not enough system resources to complete this operation. The most common reason of this return code is using too many DMA buffers, or using DMA buffers that are too big. Please try reducing the number of buffers posted to the board at any time, and/or try reducing the DMA buffer sizes.

enumerator ApiNotInitialized

The API has not been properly initialized for this function call. Please review one of the code samples from the ATS-SDK to confirm that API calls are made in the right order.

enumerator ApiInvalidPowerState

Power state requested is not valid.

enumerator ApiPowerDown

The operation cannot be completed because the device is powered down. For example, this error code is output if the computer enters hiberanation while an acquisition is running.

enumerator ApiNotSupportThisChannel

The API call is not valid with this channel selection.

enumerator ApiNoAction

The function has requested no action to be taken.

enumerator ApiHSNotSupported

HotSwap is not supported.

enumerator ApiVpdNotEnabled

Vital product data not enabled.

enumerator ApiInvalidOffset

Offset argument is not valid.

enumerator ApiPciTimeout

Timeout on the PCI bus.

enumerator ApiInvalidHandle

Invalid handle passed as argument.

enumerator ApiBufferNotReady

The buffer passed as argument is not ready to be called with this API. This error code is most often seen is the order of buffers posted to the board is not respected when querying them.

enumerator ApiInvalidData

Generic invalid parameter error. Check the function’s documentation for more information about valid argument values.

enumerator ApiDoNothing

enumerator ApiDmaSglBuildFailed

Unable to lock buffer and build SGL list.

enumerator ApiPMNotSupported

Power management is not supported.

enumerator ApiInvalidDriverVersion

Invalid driver version.

enumerator ApiWaitTimeout

The operation did not finish during the timeout interval. try the operation again, or abort the acquisition.

enumerator ApiWaitCanceled

The operation was cancelled.

enumerator ApiBufferTooSmall

The buffer used is too small. Try increasing the buffer size.

enumerator ApiBufferOverflow

The board overflowed its internal (on-board) memory. Try reducing the sample rate, reducing the number of enabled channels. Also ensure that DMA buffer size is between 1 MB and 8 MB.

enumerator ApiInvalidBuffer

The buffer passed as argument is not valid.

enumerator ApiInvalidRecordsPerBuffer

The number of reocrds per buffer passed as argument is invalid.

enumerator ApiDmaPending

585 - An asynchronous I/O operation was successfully started on the board. It will be completed when sufficient trigger events are supplied to the board to fill the buffer.

enumerator ApiLockAndProbePagesFailed

The buffer is too large for the driver or operating system to prepare for scatter-gather DMA transfer. Try reducing the size of each buffer, or reducing the number of buffers queued by the application.

enumerator ApiTransferComplete

This buffer is the last in the current acquisition.

enumerator ApiPllNotLocked

The on-board PLL circuit could not lock. If the acquisition used an internal sample clock, this might be a symptom of a hardware problem; contact AlazarTech. If the acquisition used an external 10 MHz PLL signal, please make sure that the signal is fed in properly.

enumerator ApiNotSupportedInDualChannelMode

The requested acquisition is not possible with two channels. This can be due to the sample rate being too fast for DES boards, or to the number of samples per record being too large. Try reducing the number of samples per channel, or switching to single channel mode.

enumerator ApiNotSupportedInQuadChannelMode

The requested acquisition is not possible with four channels. This can be due to the sample rate being too fast for DES boards, or to the number of samples per record being too large. Try reducing the number of samples per channel, or switching to single channel mode.

enumerator ApiFileIoError

A file read or write error occured.

enumerator ApiInvalidClockFrequency

The requested ADC clock frequency is not supported.

enumerator ApiInvalidSkipTable

Invalid skip table passed as argument.

enumerator ApiInvalidDspModule

This DSP module is not valid for the current operation.

enumerator ApiDESOnlySupportedInSingleChannelMode

Dual-edge sampling mode is only supported in signel-channel mode. Try disabling dual-edge sampling (lowering the sample rate if using internal clock), or selecting only one channel.

enumerator ApiInconsistentChannel

Successive API calls of the same acuqiisiton have received inconsistent acquisition channel masks.

enumerator ApiDspFiniteRecordsPerAcquisition

DSP acquisition was run with a finite number of records per acqusiition. Set this value to inifinite.

enumerator ApiNotEnoughNptFooters

Not enough NPT footers in the buffer for extraction.

enumerator ApiInvalidNptFooter

Invalid NPT footer found.

enumerator ApiOCTIgnoreBadClockNotSupported

OCT ignore bad clock is not supported.

enumerator ApiError1

The requested number of records in a single-port acquisition exceeds the maximum supported by the digitizer. Use dual-ported AutoDMA to acquire more records per acquisition.

enumerator ApiError2

The requested number of records in a single-port acquisition exceeds the maximum supported by the digitizer.

enumerator ApiOCTNoTriggerDetected

No trigger is detected as part of the OCT ignore bad clock feature.

enumerator ApiOCTTriggerTooFast

Trigger detected is too fast for the OCT ignore bad clock feature.

enumerator ApiNetworkError

There was a network-related issue. Make sure that the network connection and settings are correct.

enumerator ApiFftSizeTooLarge

On-FPGA FFT cannot support FFT that large. Try reducing the FFT size, or querying the maximum FFT size with AlazarDSPGetInfo()

enumerator ApiGPUError

GPU returned an error. See log for more information.

enumerator ApiAcquisitionModeOnlySupportedInFifoStreaming

This board only supports this acquisition mode in FIFO only streaming mode. Please set the ADMA_FIFO_ONLY_STREAMING flag in AlazarBeforeAsyncRead().

enumerator ApiInterleaveNotSupportedInTraditionalMode

This board does not support sample interleaving in traditional acquisition mode. Please refer to the SDK guide for more information.

enumerator ApiRecordHeadersNotSupported

This board does not support record headers. Please refer to the SDK guide for more information.

enumerator ApiRecordFootersNotSupported

This board does not support record footers. Please refer to the SDK guide for more information.

enumerator ApiFastBufferLockCountExceeded

The number of different DMA buffers posted exceeds the limit set with AlazarConfigureFastBufferLock(). Either disable fast buffer locking, or confirm that the value passed to AlazarConfigureFastBufferLock() is respected.

enumerator ApiInvalidStateDoRetry

The operation could not complete because the system is in an invalid state. You may safely retry the call that returned this error.

enumerator ApiInvalidInputRange

The operation could not complete because the system is in an invalid state. You may safely retry the call that returned this error.

enumerator ApiBusy

The operation could not complete because the system is in a busy state. You may safely retry the call that returned this error.

enumerator ApiNoRcPathVariable

Under Linux, ATSApi looks for an ALAZARRCPATH or a HOME environment variable to know where to store the .alazarrc configuration file. This error indicates that none of these variables were identified.

enumerator ApiOnFpgaFftOptionMissing

This board requires an option to be active to perform on-FPGA FFTs.