Welcome to the new DelphiDabbler Code Library Documentation.

This is a new site that's currently running on alpha code. There are going to be bugs. If you discover any, please report them on the site's issues page (GitHub account required). Thanks.

Warning: Many URLs are going to change. Refer to the README file to discover which library project's documentation has been completed.

WriteHandle property

Project: I/O Utility Classes

Unit: PJPipe

Class: TPJPipe

Applies to: ~>1.0

property WriteHandle: THandle;

Description

This read only property provides access to the Windows handle used to write data to the pipe.

This handle can be passed to file writing routines that take a handle as a parameter, such as those provided in Delphi’s SysUtils and Windows units. Alternatively, if you want to write to the pipe via a TStream object, create a THandleStream instance for the handle.

Remarks

Do not pass this handle to any Windows API function that may alter it (e.g. CloseHandle).

If you do need to close WriteHandle then use the CloseWriteHandle method. CloseWriteHandle closes the handle and sets it to 0.

WriteHandle should not be used when it is 0.