a0DisposePipe()

Destroys a pipe.


Syntax

a0tError a0DisposePipe(
a0tPipe *pipe);

Arguments

Namerd/wrDescription
pipe read Pipe to destroy.

Description

This function destroys a pipe previously created by a0NewPipe(). All pending communications are waited (see a0Flush()) and no further communication is allowed. The buffer allocated to the pipe is freed, but its port descriptor is left untouched.


Return Values

If an error condition occurs, it returns the error code, otherwise it returns A0ErrOk. Possible values are as follows:
Error CodeDescription
A0Err...Some error occurred.
A0ErrOkSuccessful completion.

See Also

a0NewPipe() a0IFPut() a0IFGet() a0Flush()