Sys2CheckNamedPipe: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Check the status of a named pipe (server side). | Check the status of a named pipe (server side). | ||
This function is designed for use by the process that created the pipe (i.e. the server side). | This function is designed for use by the process that created the pipe (i.e. the server side). Clients which are accessing a named pipe should use the standard REXX STREAM and/or CHARS functions to determine the pipe's status. | ||
==Arguments== | ==Arguments== | ||
The pipe handle (from Sys2CreateNamedPipe or DosOpen). | The pipe handle (from Sys2CreateNamedPipe or DosOpen). (REQUIRED) | ||
==Return Value== | |||
String of the format "bytes status", where bytes is the number of bytes currently waiting in the pipe, and status is one of: DISCONNECTED, LISTENING, CONNECTED, or CLOSING. | String of the format "bytes status", where bytes is the number of bytes currently waiting in the pipe, and status is one of: DISCONNECTED, LISTENING, CONNECTED, or CLOSING. | ||
[[Category:RxUtilEx]] | [[Category:RxUtilEx]] | ||
Latest revision as of 00:46, 4 July 2023
Check the status of a named pipe (server side).
This function is designed for use by the process that created the pipe (i.e. the server side). Clients which are accessing a named pipe should use the standard REXX STREAM and/or CHARS functions to determine the pipe's status.
Arguments
The pipe handle (from Sys2CreateNamedPipe or DosOpen). (REQUIRED)
Return Value
String of the format "bytes status", where bytes is the number of bytes currently waiting in the pipe, and status is one of: DISCONNECTED, LISTENING, CONNECTED, or CLOSING.