Changeset 19

Timestamp:

Sep 25, 2014, 4:11:17 PM (11 years ago)

Author:

Alex Taylor

Message:

Updates to function documentation.

File:

• rxutilex/trunk/FUNCTIONS (modified) (5 diffs)

rxutilex/trunk/FUNCTIONS

@@ -3 +3 @@
 (See file 'TODO' for functions which are under consideration to be added.)
 
-Sys2CheckNamedPipe          - Check the status of a named pipe
+Sys2CheckNamedPipe          - Check the status of a named pipe (server side)
 Sys2Close                   - Close a file or named pipe
 Sys2ConnectNamedPipe        - Enable client sessions on a named pipe
@@ -37 +37 @@
 Sys2CheckNamedPipe
 
-Check the status of a named pipe.
+Checks the status of a named pipe that was previously created using
+Sys2CreateNamedPipe.  
+
+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.
 
 REXX ARGUMENTS:
@@ -81 +87 @@
 Note that the standard REXX functions such as CHARIN/OUT, which operate
 directly on file names, are not capable of using the pipe handle returned
-from this function. While the client end can use such functions after
+from this function.  While the client end can use such functions after
 using STREAM to issue an OPEN WRITE or OPEN READ command, the server end
 needs to use the pipe handle from this function, and must therefore use
@@ -94 +100 @@
 the amount of data currently in the pipe, use Sys2CheckNamedPipe.  To
 unlock a named pipe after a client has closed the connection, use
-Sys2DisconnectNamedPipe.  Finally, the pipe should be destroyed using
-Sys2Close when no longer needed.
+Sys2DisconnectNamedPipe.  Finally, the pipe can be destroyed using
+Sys2Close.
 
 REXX ARGUMENTS:
@@ -195 +201 @@
 configured via the LANG and LC_* environment variables.
 
+NOTE: Any date prior to 1 January 1970, or later than 19 January 2038,
+      cannot be supported due to the limitations in how the C library
+      calculates epoch time.  Specifying any date before 1970 will generate
+      a REXX error.  Any time/date later than 12:14:07 on 19 January 2038
+      will return the latter value.
+
 REXX ARGUMENTS:
   1. The year (1970-2037)
-     Years prior to 1970 or later than 2037 cannot be supported due to the
-     limitations in how the C library calculates epoch time.  Specifying
-     1969 or earlier will generate a REXX error.  Any date later than 2037
-     will return a value of 0 (and SYS2ERR will report an error in 'mktime').
-     NOTE: A 2-digit year can be specified, in which case the number will be
-           added to 1900 if it is 70 or higher, or to 2000 otherwise.
-           e.g. '20' ==> 2020
-                '75' ==> 1975
-           This is subject to the limitation noted above, such that values
-           from 38 to 69 will result in a return value of 0.
+     A 2-digit year can be specified, in which case the number will be
+     added to 1900 if it is 70 or higher, or to 2000 otherwise.
+     e.g. '20' ==> 2020
+          '75' ==> 1975
+     (This is subject to the limitation noted above.)
   2. The month (1-12)
   3. The day (1-31)