niHWS_GetWfmStringAttribute
C Function Prototype
tHWS_Status niHWS_GetWfmStringAttribute (tHWS_WfmRef wfmReference, tHWS_WfmStringAttributes attributeID, long stringSize, char attributeVal[]);
Purpose
Retrieves text attributes that apply to the waveform specified by wfmReference.
Parameters
| Name | Type | Description |
|---|---|---|
| wfmReference | tHWS_WfmRef | References to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data. |
| attributeID | tHWS_WfmStringAttributes | Selects the attribute to retrieve.
Defined Values niHWS_Attr_WfmNote— A general purpose text field for any information pertaining to the waveform. niHWS_Attr_XAxisLabel—A general purpose text field intended for labeling the x-axis of a waveform data plot. niHWS_Attr_YAxisLabel—A general purpose text field intended for labeling the y-axis of a waveform data plot. niHWS_Attr_XAxisUnits—A general purpose text field intended for denoting the units of the X Axis Increment attribute. niHWS_Attr_YAxisUnits—A general purpose text field intended for denoting the units of the waveform data. niHWS_Attr_WfmName—A read-only attribute that is the same as that returned by niHWS_GetWfmName. niHWS_AttrValid_Signals—The list of lines (or bits) in the samples of a digital waveform that are valid. For example, "0,3,6" means that only bits 0, 3, and 6 of each unsigned long digital sample contain valid digital data. A hyphen may be used to denote an inclusive range of consecutive lines. For example, "2-5" is equivalent to "2, 3, 4, 5". niHWS_Attr_WfmTimestamp—A string of the form hour:minutes:seconds.fractional seconds followed by AM or PM MM/DD/YYYY. Intended to serve as the time the waveform was originally acquired. |
| stringSize | long | The number of characters that the string allocated for attributeVal
can hold. If stringSize is 0 and no error occurs, the actual size of the string attribute, including the end of string termination character, is returned in the status parameter. |
| attributeVal | char[] | The current setting of the attribute specified by attributeID. |