Flush Stream Function

Owning Palette: Network Streams Functions

Requires: Base Development System (Windows)

Transfers all data to the reader endpoint before data flow resumes. You can call this function from the writer endpoint only. Use this function before using the Destroy Endpoint function to ensure that the writer endpoint buffer is empty before you destroy it.

Add to the block diagram

Find on the palette

	endpoint in specifies the reference to the writer endpoint. Obtain this reference by wiring the endpoint out output of the Write Single Element to Stream or Write Multiple Elements to Stream function to this input.
	wait condition specifies the condition under which data flow resumes. 0 All Elements Read from Stream (default)—Specifies that data flow resumes when the Network Streams Engine transfers all data to the reader endpoint and the reader endpoint finishes reading that data. 1 All Elements Available for Reading—Specifies that data flow resumes when the Network Streams Engine transfers all data to the reader endpoint but before the reader endpoint finishes reading that data.
	timeout in ms is the time, in milliseconds, that this function waits for the wait condition to complete. The default is -1, which means the function waits indefinitely.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	endpoint out returns endpoint in unchanged.
	timed out? returns TRUE if the wait condition does not complete within the timeout period.
	error out contains error information. This output provides standard error out functionality.