niHWS_SetGroupStringAttribute
C Function Prototype
tHWS_Status niHWS_SetGroupStringAttribute (tHWS_FileHandle fileHandle, const char groupName[], tHWS_GroupStringAttributes attributeID, const char attributeVal[]);
Purpose
Sets the value of text attributes that apply to all the waveforms within a group.
Parameters
Name | Type | Description |
---|---|---|
fileHandle | tHWS_FileHandle | Refers to an open HWS file. |
groupName | const char[] | The name of the group. Groups are identified by name for purposes of setting and
getting group attributes.
If only one group is in the file this parameter can be NULL or the empty string. |
attributeID | tHWS_GroupStringAttributes | Selects the attribute to set.
Defined Values niHWS_Attr_GroupNote—A general purpose text field for any comment that applies to all the waveforms stored in this group. niHWS_Attr_Technician—A general purpose text field intended for the name of the technician who acquired or generated the waveforms in this group. niHWS_Attr_Project—A general purpose text field intended for any information about the project for which the waveforms in this group were created. niHWS_Attr_GroupTimestamp—A string of the form hour:minutes:seconds.fractional seconds followed by AM or PM MM/DD/YYYY. This string is intended to refer to all the waveforms in the group. |
attributeVal | const char[] | The new setting of the attribute specified by attributeID. |