niHWS Retrieve Waveform

NI Digital Waveform Generator/Analyzer Help

Edition Date: June 2013

Part Number: 370520P-01

»View Product Info
Download Help (Windows Only)

Retrieves the waveform from the file specified. The instances of this polymorphic VI correspond to the type of analog or digital data you are retrieving.

Use the pull-down menu to select an instance of this VI.

Retrieve Analog WDT

Retrieves the analog waveform data from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
analog waveform contains the data for the waveform.
offset is equivalent to element 0 of the scaling coefficient array.
Note  If a waveform stored as integers is retrieved by this VI, NI-HWS scales the integers to floating point numbers using the scaling coefficient array and sets the offset parameter to 0.
gain is equivalent to element 1 of the scaling coefficient array.
Note  If a waveform stored as integers is retrieved by this VI, NI-HWS scales the integers to floating point numbers using the scaling coefficient array and sets the gain parameter to 1.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Analog DBL

Retrieves the analog waveform from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
data contains the data for the waveform.
offset is equivalent to element 0 of the scaling coefficient array.
Note  If a waveform stored as integers is retrieved by this VI, NI-HWS scales the integers to floating point numbers using the scaling coefficient array and sets the offset parameter to 0.
gain is equivalent to element 1 of the scaling coefficient array.
Note  If a waveform stored as integers is retrieved by this VI, NI-HWS scales the integers to floating point numbers using the scaling coefficient array and sets the gain parameter to 1.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Analog I8

Retrieves the analog waveform samples as 8-bit signed integers (I8) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
data contains the data for the waveform.
offset is equivalent to element 0 of the scaling coefficient array.
gain is equivalent to element 1 of the scaling coefficient array.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Analog I16

Retrieves the analog waveform samples as 16-bit integers (I16) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
data contains the data for the waveform.
offset is equivalent to element 0 of the scaling coefficient array.
gain is equivalent to element 1 of the scaling coefficient array.
new file path passes the path to the file where the data was stored.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Analog I32

Retrieves the analog waveform samples as an array of 32-bit signed integers (I32) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
data contains the data for the waveform.
offset is equivalent to element 0 of the scaling coefficient array.
gain is equivalent to element 1 of the scaling coefficient array.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Digital WDT

Retrieves the digital waveform from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
digital waveform contains the data for the waveform.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Digital 1D U8

Retrieves the digital waveform samples as an array of 8-bit unsigned integers (U8) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
data contains the data for the waveform.
valid signals lists the lines (or bits) in the digital samples that are valid. For example, "0,3,6" means that only bits 0, 3, and 6 of each U8 digital sample contain valid digital data.

The values in the string can receive any integer value between 0 and 7. Individual lines are separated by commas. You can use a hyphen to denote an inclusive range of lines. For example,"2-5" is equivalent to "2,3,4,5".

error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Digital 2D U8

Retrieves the digital waveform samples as a two-dimensional array of 8-bit unsigned integers (U8) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples per row in wfm returns the number of samples per row in the waveform data array.
data contains the data for the waveform.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Digital 1D U16

Retrieves the digital waveform samples as an array of 16-bit unsigned integers (U16) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
data contains the data for the waveform.
valid signals lists the lines (or bits) in the digital samples that are valid. For example, "0,3,6" means that only bits 0, 3, and 6 of each U16 digital sample contain valid digital data.

The values in the string can receive any integer value between 0 and 15. Individual lines are separated by commas. You can use a hyphen to denote an inclusive range of lines. For example, "2-5" is equivalent to "2,3,4,5".

error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Digital 2D U16

Retrieves the digital waveform samples as a two-dimensional array of 16-bit integers (U16) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples per row in wfm returns the number of samples per row in the waveform data array.
data contains the data for the waveform.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Digital 1D U32

Retrieves the digital waveform samples as an array of 32-bit unsigned integers (U32) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples in wfm reports the total number of samples in the waveform.
data contains the data for the waveform.
valid signals lists the lines (or bits) in the digital samples that are valid. For example, "0,3,6" means that only bits 0, 3, and 6 of each U32 digital sample contain valid digital data.

The values in the string can receive any integer value between 0 and 31. Individual lines are separated by commas. You can use a hyphen to denote an inclusive range of lines. For example, "2-5" is equivalent to "2,3,4,5".

error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Retrieve Digital 2D U32

Retrieves the digital waveform samples as a two-dimensional array of 32-bit integers (U32) from the file specified.

file path specifies the path and file name of the HWS file to open. The .hws extension is typically used for HWS files, although using this extension is optional.
error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

rate is the rate of the Sample clock used to capture the waveform.
new file path passes the path to the file where the data was stored.
num samples per row in wfm returns the number of samples per row in the waveform data array.
data contains the data for the waveform.
error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code identifies the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source describes the origin of the error or warning.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WAS THIS ARTICLE HELPFUL?

Not Helpful