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

513 The operation failed

enumerator ApiAccessDenied

514 Access denied

enumerator ApiDmaChannelUnavailable

515 Channel selection is unavailable

enumerator ApiDmaChannelInvalid

516 Channel selection in invalid

enumerator ApiDmaChannelTypeError

517 Channel selection is invalid

enumerator ApiDmaInProgress

518 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

519 DMA transfer is finished

enumerator ApiDmaPaused

520 DMA transfer was paused

enumerator ApiDmaNotPaused

521 DMA transfer is not paused

enumerator ApiDmaCommandInvalid

522 A DMA command is invalid

enumerator ApiNullParam

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

enumerator ApiUnsupportedFunction

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

enumerator ApiInvalidPciSpace

534 Invalid PCI space

enumerator ApiInvalidIopSpace

535 Invalid IOP space

enumerator ApiInvalidSize

536 Invalid size passed as argument to the function

enumerator ApiInvalidAddress

537 Invalid address

enumerator ApiInvalidAccessType

538 Invalid access type requested

enumerator ApiInvalidIndex

539 Invalid index

enumerator ApiInvalidRegister

543 Invalid register

enumerator ApiConfigAccessFailed

550 Access for configuration failed

enumerator ApiInvalidDeviceInfo

551 Invalid device information

enumerator ApiNoActiveDriver

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

enumerator ApiInsufficientResources

553 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

556 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

558 Power state requested is not valid

enumerator ApiPowerDown

559 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

561 The API call is not valid with this channel selection.

enumerator ApiNoAction

562 The function has requested no action to be taken

enumerator ApiHSNotSupported

563 HotSwap is not supported

enumerator ApiVpdNotEnabled

565 Vital product data not enabled

enumerator ApiInvalidOffset

567 Offset argument is not valid

enumerator ApiPciTimeout

569 Timeout on the PCI bus

enumerator ApiInvalidHandle

572 Invalid handle passed as argument

enumerator ApiBufferNotReady

573 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

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

enumerator ApiDoNothing

575

enumerator ApiDmaSglBuildFailed

576 Unable to lock buffer and build SGL list

enumerator ApiPMNotSupported

577 Power management is not supported

enumerator ApiInvalidDriverVersion

578 Invalid driver version

enumerator ApiWaitTimeout

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

enumerator ApiWaitCanceled

580 The operation was cancelled.

enumerator ApiBufferTooSmall

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

enumerator ApiBufferOverflow

582 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

583 The buffer passed as argument is not valid.

enumerator ApiInvalidRecordsPerBuffer

584 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

586 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

589 This buffer is the last in the current acquisition

enumerator ApiPllNotLocked

590 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

591 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

592 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

593 A file read or write error occured.

enumerator ApiInvalidClockFrequency

594 The requested ADC clock frequency is not supported.

enumerator ApiInvalidSkipTable

595 Invalid skip table passed as argument

enumerator ApiInvalidDspModule

596 This DSP module is not valid for the current operation.

enumerator ApiDESOnlySupportedInSingleChannelMode

597 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

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

enumerator ApiDspFiniteRecordsPerAcquisition

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

enumerator ApiNotEnoughNptFooters

600 Not enough NPT footers in the buffer for extraction

enumerator ApiInvalidNptFooter

601 Invalid NPT footer found

enumerator ApiOCTIgnoreBadClockNotSupported

602 OCT ignore bad clock is not supported

enumerator ApiError1

603 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

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

enumerator ApiOCTNoTriggerDetected

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

enumerator ApiOCTTriggerTooFast

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

enumerator ApiNetworkError

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

enumerator ApiFftSizeTooLarge

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

enumerator ApiGPUError

609 GPU returned an error. See log for more information

enumerator ApiAcquisitionModeOnlySupportedInFifoStreaming

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

enumerator ApiInterleaveNotSupportedInTraditionalMode

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

enumerator ApiRecordHeadersNotSupported

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

enumerator ApiRecordFootersNotSupported

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

enumerator ApiFastBufferLockCountExceeded

614 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

615 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

616 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

617 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

618 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

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

enumerator ApiReferenceClockPllNotLocked

620 The PLL of the reference clock was not locked.

enumerator ApiAdcJesdPllNotLocked

621 The JESD link PLL on ADC is not locked.

enumerator ApiAdcJesdLinkNotLocked

622 The JESD link on ADC is not locked.

enumerator ApiFpgaJesdLinkNotLocked

623 The JESD link on FPGA is not locked.

enumerator ApiInvalidFirmwareForATS9364

624 The library does not support FPGA versions under 4.07 for ATS9364. Frimware must be updated.

enumerator ApiHardwareRemoved

625 The hardware is no longer detected in the system.

enumerator ApiInvalidFirmwareForATS4001

626 The library does not support FPGA versions under 6.0 for ATS4001. Frimware must be updated.

enumerator ApiInvalidLicense

627 Invalid license for running the desired software.