DS_DeleteAttr
- Updated2023-02-21
- 1 minute(s) read
HRESULT DS_DeleteAttr (DSHandle DSHandle, const char *attributeName);
Purpose
Removes an attribute from a DataSocket object.
You must still call DS_DiscardObjHandle for each handle to the attribute that you obtained by calling DS_GetAttrHandle or DS_CreateAttrHandle.
Parameters
| Input | ||
| Name | Type | Description |
| DSHandle | DSHandle | Pass the handle you obtained from DS_Open, DS_GetAttrHandle, or DS_CreateAttrHandle to identify the DataSocket object. |
| attributeName | const char * | A string to specify the name of the attribute. If the attribute does not exist, this function returns E_INVALIDARG (0x80070057). |
Return Value
| Name | Type | Description |
| status | HRESULT | The value that indicates whether an error occurred. A negative error code indicates function failure. Error codes are defined in CVIversion\toolslib\datasock\dataskt.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. Other error codes in winerror.h are generated by ActiveX Servers and are passed on to you by the DataSocket Library. |
Additional Information
Library: DataSocket Library
Include file: datasock\dataskt.h
LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later