niHWS_GetWfmI32Attribute

NI-HWS C Function Reference

niHWS_GetWfmI32Attribute

C Function Prototype

tHWS_Status niHWS_GetWfmI32Attribute (tHWS_WfmRef wfmReference, tHWS_WfmI32Attributes attributeID, long* attributeVal);

Purpose

Retrieves integer attributes that apply to the waveform specified by wfmReference.

Parameters

Name Type Description
wfmReference tHWS_WfmRef A reference to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data.
attributeID tHWS_WfmI32Attributes The waveform attribute to retrieve.

niHWS_Attr_YAxisDataType— A read-only attribute that returns the type of integer or floating-point data that the waveform is stored as.

Defined Values

niHWS_Val_DataTypeI8 niHWS_Val_DataTypeI16
niHWS_Val_DataTypeI32
niHWS_Val_DataTypeF64
niHWS_Val_DataTypeU32
niHWS_Val_DataTypeDWDT
niHWS_Val_DataTypeU8
niHWS_Val_DataTypeU16

niHWS_Attr_IOType—A read-only attribute that returns the type of the waveform as either analog (niHWS_Val_Analog), digital (niHWS_Val_Digital), or unknown (niHWS_Val_Unknown).

niHWS_Attr_ScalingType—A read-only attribute that returns the only currently supported scaling type of niHWS_Val_Polynomial.

niHWS_Attr_WaveformSize—A read-only attribute that returns the total number of samples in a waveform. For digital 2D files with multiple rows, this attribute refers to the number of samples per row.

niHWS_Attr_NumRows—A read-only attribute that returns the number of rows in the waveform.

niHWS_Attr_NumSignals—A read-only attribute that returns the number of signals in the waveform.

attributeVal long* The current setting of the attribute specified by attributeID.

Return Value