DS_GetDataUpdated
- Updated2023-02-21
- 1 minute(s) read
HRESULT DS_GetDataUpdated (DSHandle DSHandle, BOOL *dataUpdated);
Purpose
Returns the value of a DataSocket object's DataUpdated property.
The DataUpdated property is a Boolean that indicates whether a DataSocket object has synchronized with the DataSocket data source since the last time you read the DataSocket object's data value or attributes. In the polling model, this property also indicates if there is new data in the polling queue.
The value of the DataUpdated property of a DataSocket object that is configured for Read mode is set to non-zero when you call DS_Update on the DataSocket object. The value is set to zero when you call DS_GetDataType, DS_GetDataValue, DS_GetAttrType, or DS_GetAttrValue.
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. |
| Output | ||
| Name | Type | Description |
| dataUpdated | BOOL | Returns the value of the DataUpdated property of the DataSocket object you specify. |
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