Flush Stream Function
- Updated2025-07-30
- 3 minute(s) read
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.

Inputs/Outputs
endpoint in
—
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
—
wait condition specifies the condition under which data flow resumes.
timeout in ms (-1)
—
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 (no error)
—
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
endpoint out
—
endpoint out returns endpoint in unchanged.
timed out?
—
timed out? returns TRUE if the wait condition does not complete within the timeout period.
error out
—
error out contains error information. This output provides standard error out functionality. |
endpoint in
—
wait condition
—
timeout in ms (-1)
—
error in (no error)
—
endpoint out
—
timed out?
—
error out
—