DS_SetPollingQueueSizeInPackets
- Updated2023-02-21
- 1 minute(s) read
HRESULT DS_SetPollingQueueSizeInPackets (DSHandle DSHandle, int size);
Purpose
Sets the size of the polling queue in packets. This is the maximum number of packets the polling queue can hold. Note that calling this function does not change the number of bytes to hold in the polling queue. The polling queue manages the size in bytes independent of the size in packets, and satisfies both settings.
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. |
| size | int | Pass the number of packets to set the polling queue size. The polling queue will be resized to hold this number of packets. If you reduce the polling queue size, then any data in the truncated portion of the queue will be lost. |
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