niDigital Fetch Capture Waveform (U32) (VI)

Digital Pattern Help

Edition Date: May 2018

Part Number: 375145e

»View Product Info
Download Help (Windows Only)
Owning Palette: Source and Capture
Installed With: NI-Digital

Fetches a defined number of samples for a specific list of sites.

This VI only returns data from sites that are enabled when fetch is called.

niDigital Fetch Capture Waveform (U32)

/images/reference/en-XX/help/375145e/cstr.gif

waveform name specifies the waveform name you create with the niDigital Create Capture Waveform VI. Use the waveform name with capture_start opcode in your pattern.

/images/reference/en-XX/help/375145e/cio.gif

instrument handle specifies the instrument session the niDigital Initialize with Options VI returns.

/images/reference/en-XX/help/375145e/cstr.gif

site list specifies a comma-delimited list of strings in the form of siteN, where N is the site number. If you enter an empty string, the VI fetches data from all sites.

/images/reference/en-XX/help/375145e/cdbl.gif

timeout (s) specifies the maximum time allowed for this VI to complete in seconds. If this VI does not complete within this time interval, this VI returns an error.

/images/reference/en-XX/help/375145e/ci64.gif

samples to read specifies the number of samples to fetch. A value of -1 specifies to fetch all available samples.

/images/reference/en-XX/help/375145e/cerrcodeclst.gif

error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

/images/reference/en-XX/help/375145e/cbool.gif

status is TRUE (X) if an error occurred before this VI ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI ran. The default is FALSE.

/images/reference/en-XX/help/375145e/ci32.gif

code specifies the error or warning code. The default is 0. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.

/images/reference/en-XX/help/375145e/cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI that produced the error or warning. The default is an empty string.

/images/reference/en-XX/help/375145e/iio.gif

instrument handle out returns the handle that identifies the session in all subsequent VI calls.

/images/reference/en-XX/help/375145e/iu32.gif

data returns a 2D array of digital states read from the sites in the site list. Each row in the 2D array corresponds to a site in the list. If a site is disabled, not enabled for burst, or the current digital pattern instrument does not include any capture pins, the VI does not return data for that site. Use the niDigital Sort Site Results (U32 Waveform) VI to order and combine the data to match the site list. You can also use the niDigital Get Site Results Site Numbers VI to determine the order of the sites returned from this VI call so that you can match the pass array with site numbers.

/images/reference/en-XX/help/375145e/ierrcodeclst.gif

error out contains error information. This output provides standard error out functionality.

/images/reference/en-XX/help/375145e/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/375145e/ii32.gif

code is the error or warning code. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.

/images/reference/en-XX/help/375145e/istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI that produced the error or warning.

WAS THIS ARTICLE HELPFUL?

Not Helpful