niTuner_ready

NI Tuner

previous page next page

niTuner_ready

Function Prototype

int niTuner_ready (int taskID, double timeout, unsigned long *ready);

Purpose

This function returns the ready status of the PXI-5600 downconverter. The PXI-5600 is ready if the device is sufficiently settled on the requested frequency and all Phase Locked Loops (PLLs) are locked. Ready state is indicated by the ready function output and the STATUS light on the PXI-5600 downconverter front panel.

Parameters

Name Type Description
taskID int

The Task ID obtained from niTuner_init that identifies the session of a particular device.

timeout double

Timeout in seconds to wait for the ready status:

  • A timeout of 0 returns the current ready status.
  • A negative timeout value waits until the PXI-5600 is ready.
  • A positive timeout value waits the specified number of seconds (at most) for a ready status.
ready unsigned long *

Indicates the ready status of the PXI-5600:

  • A positive value indicates the PLLs are locked.
  • A value of 0 indicates the PXI-5600 is not locked and ready.

Return Value

Returns the status of the function. To see an explanation of common error and warning codes, see Error and Status Codes. To see a text explanation of the status code, call niTuner_errorHandler.

previous page start next page