DS_GetPollingQueuePacketsUtilization
- Updated2023-02-21
- 1 minute(s) read
HRESULT DS_GetPollingQueuePacketsUtilization (DSHandle DSHandle, double *utilizationFraction);
Purpose
Returns the number of packets currently in the polling queue divided by the size of the polling queue in packets.
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 |
| utilizationFraction | double | The number of packets currently in the polling queue divided by the size of the polling queue in packets. |
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 7.0 and later