Admin Production ni-theme
Current Publication

CNSReadMultipleData

LabWindows/CVI

CNSReadMultipleData

int CNSReadMultipleData (CNSEndpoint endpointID, int timeout, CNSData dataArray[], size_t numElements, size_t *numElementsRead);

Purpose

Reads multiple network stream data objects from a network stream. You can call this function from the reader endpoint only.

Note Note  CNSReadMultipleData does not support network stream data containing scalar arrays. Use CNSReadArray in a loop instead.

Parameters

Input
Name Type Description
endpointID CNSEndpoint The handle of a network stream endpoint. You can obtain this handle using the CNSNewEndpoint function.
timeout int The time, in milliseconds, that this function waits for the data to be available in the buffer. The default value is CNSWaitForever, which means this endpoint waits indefinitely. If the timeout expires, this function returns an error.
numElements size_t The number of network stream data objects you want to read from the network stream.
Output
Name Type Description
dataArray CNSData [] The array of network stream data objects read from the network stream.
numElementsRead size_t The total number of network stream data objects that the function actually read from the network stream.

Note Note  numElementsRead is different than numElements if the writer endpoint was discarded and there are still elements in the reader buffer, but numElements is greater than the number of elements that remain in the buffer. After the function reads the remaining elements in the buffer, it returns the number of elements read in the numElementsRead parameter.
You can pass NULL for this parameter.

Return Value

Name Type Description
error int An error code returned by a Network Streams Library function.

Additional Information

Library: Network Streams Library

Include file: cvinetstreams.h

LabWindows/CVI compatibility: LabWindows/CVI 2013 and later