From fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 Mon Sep 17 00:00:00 2001
From: Joseph Hunkeler <jhunkeler@gmail.com>
Date: Wed, 8 Jul 2015 20:46:52 -0400
Subject: Initial commit

---
 unix/os/doc/zgfdir.hlp | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 unix/os/doc/zgfdir.hlp

(limited to 'unix/os/doc/zgfdir.hlp')

diff --git a/unix/os/doc/zgfdir.hlp b/unix/os/doc/zgfdir.hlp
new file mode 100644
index 00000000..7c5412cf
--- /dev/null
+++ b/unix/os/doc/zgfdir.hlp
@@ -0,0 +1,37 @@
+.help zgfdir May84 "System Interface"
+.ih
+NAME
+zgfdir -- get next filename from a directory
+.ih
+SYNOPSIS
+.nf
+zgfdir (chan, osfn, maxch, status)
+
+int	chan			# OS channel of directory file
+packed	char osfn[maxch]	# output filename
+int	maxch, status
+.fi
+.ih
+DESCRIPTION
+The next machine dependent filename is returned from the directory file
+connected to \fIchan\fR.  Filenames are not returned in any particular order.
+The filename is returned as an EOS delimited packed string with no newline.
+.ih
+RETURN VALUE
+The number of characters in the filename excluding the EOS delimiter is
+returned for a successful read.  EOF is returned when the directory is
+exhausted.  ERR is returned if there is something wrong with \fIchan\fR,
+if a read error occurs, or if the output string overflows.
+.ih
+NOTES
+Although this primitive returns simple, raw host filenames, it will not
+necessarily return all of the filenames in a directory.  On a UNIX system
+for example, filenames which begin with the character "." are skipped over
+when reading from a directory.  On a VMS system only the most recent version
+of a file should be returned (with the version label stripped).  The kernel
+may employ hidden files for special purposes; normally these should be
+hidden from the high level code and from the user.
+.ih
+SEE ALSO
+zopdir, zcldir, zfinfo, zfacss
+.endhelp
-- 
cgit 

