Regular API function

simTubeClose / sim.tubeClose

Description Closes a communication tube previously opened with sim.tubeOpen. Data written with sim.tubeWrite and that hasn't been read yet on the other side of the tube will persist.
C synopsis simInt simTubeClose(simInt tubeHandle)
C parameters
tubeHandle: the handle of the tube that was returned by the simTubeOpen function. Once a tube was closed on one side, it is again ready for a new connection.
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number result=sim.tubeClose(number tubeHandle)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page