AlazarErrorToText

Function Syntax

const char* AlazarErrorToText(RETURN_CODE retCode)

Converts a numerical return code to a NULL terminated string.

Return

A string containing the identifier name of the error code

Remark

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

Parameters

• retCode: Return code from an AlazarTech API function

LabVIEW Block Diagram

Related Enumerations

enum RETURN_CODE

API functions return codes. Failure is ApiSuccess.

Values:

ApiSuccess = API_RETURN_CODE_STARTS

512 - The operation completed without error

ApiFailed = 513

The operation failed.

ApiAccessDenied = 514

Access denied.

ApiDmaChannelUnavailable = 515

Channel selection is unavailable.

ApiDmaChannelInvalid = 516

Channel selection in invalid.

ApiDmaChannelTypeError = 517

Channel selection is invalid.

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.

ApiDmaDone = 519

DMA transfer is finished.

ApiDmaPaused = 520

DMA transfer was paused.

ApiDmaNotPaused = 521

DMA transfer is not paused.

ApiDmaCommandInvalid = 522

A DMA command is invalid.

ApiNullParam = 531

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

ApiUnsupportedFunction = 533

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

ApiInvalidPciSpace = 534

Invalid PCI space.

ApiInvalidIopSpace = 535

Invalid IOP space.

ApiInvalidSize = 536

Invalid size passed as argument to the function.

ApiInvalidAddress = 537

Invalid address.

ApiInvalidAccessType = 538

Invalid access type requested.

ApiInvalidIndex = 539

Invalid index.

ApiInvalidRegister = 543

Invalid register.

ApiConfigAccessFailed = 550

Access for configuration failed.

ApiInvalidDeviceInfo = 551

Invalid device information.

ApiNoActiveDriver = 552

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

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.

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.

ApiInvalidPowerState = 558

Power state requested is not valid.

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.

ApiNotSupportThisChannel = 561

The API call is not valid with this channel selection.

ApiNoAction = 562

The function has requested no action to be taken.

ApiHSNotSupported = 563

HotSwap is not supported.

ApiVpdNotEnabled = 565

Vital product data not enabled.

ApiInvalidOffset = 567

Offset argument is not valid.

ApiPciTimeout = 569

Timeout on the PCI bus.

ApiInvalidHandle = 572

Invalid handle passed as argument.

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.

ApiInvalidData = 574

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

ApiDoNothing = 575

ApiDmaSglBuildFailed = 576

Unable to lock buffer and build SGL list.

ApiPMNotSupported = 577

Power management is not supported.

ApiInvalidDriverVersion = 578

Invalid driver version.

ApiWaitTimeout = 579

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

ApiWaitCanceled = 580

The operation was cancelled.

ApiBufferTooSmall = 581

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

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.

ApiInvalidBuffer = 583

The buffer passed as argument is not valid.

ApiInvalidRecordsPerBuffer = 584

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

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.

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.

ApiTransferComplete = 589

This buffer is the last in the current acquisition.

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.

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.

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.

ApiFileIoError = 593

A file read or write error occured.

ApiInvalidClockFrequency = 594

The requested ADC clock frequency is not supported.

ApiInvalidSkipTable = 595

Invalid skip table passed as argument.

ApiInvalidDspModule = 596

This DSP module is not valid for the current operation.

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.

ApiInconsistentChannel = 598

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

ApiDspFiniteRecordsPerAcquisition = 599

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

ApiNotEnoughNptFooters = 600

Not enough NPT footers in the buffer for extraction.

ApiInvalidNptFooter = 601

Invalid NPT footer found.

ApiOCTIgnoreBadClockNotSupported = 602

OCT ignore bad clock is not supported.

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.

ApiError2 = 604

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

ApiOCTNoTriggerDetected = 605

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

ApiOCTTriggerTooFast = 606

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

ApiNetworkError = 607

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

ApiFftSizeTooLarge = 608

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

ApiGPUError = 609

GPU returned an error. See log for more information.

ApiAcquisitionModeOnlySupportedInFifoStreaming = 610

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

ApiInterleaveNotSupportedInTraditionalMode = 611

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

ApiRecordHeadersNotSupported = 612

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

ApiRecordFootersNotSupported = 613

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

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.