summaryrefslogtreecommitdiffstats
path: root/funtools/doc/pod/funclose.pod
diff options
context:
space:
mode:
Diffstat (limited to 'funtools/doc/pod/funclose.pod')
-rw-r--r--funtools/doc/pod/funclose.pod53
1 files changed, 53 insertions, 0 deletions
diff --git a/funtools/doc/pod/funclose.pod b/funtools/doc/pod/funclose.pod
new file mode 100644
index 0000000..48357a3
--- /dev/null
+++ b/funtools/doc/pod/funclose.pod
@@ -0,0 +1,53 @@
+=pod
+
+=head1 NAME
+
+
+
+B<FunClose - close a Funtools data file>
+
+
+
+=head1 SYNOPSIS
+
+
+
+
+
+ #include <funtools.h>
+
+ void FunClose(Fun fun)
+
+
+
+
+
+=head1 DESCRIPTION
+
+
+
+
+The B<FunClose()> routine closes a previously-opened Funtools data
+file, freeing control structures. If a
+Funtools reference handle
+was passed to
+the FunOpen() call for this file,
+and if copy mode also was specified for that file, then
+FunClose() also will copy the
+remaining extensions from the input file to the output file (if the
+input file still is open). Thus, we recommend always closing the
+output Funtools file B<before> the input file. (Alternatively,
+you can call FunFlush()
+explicitly).
+
+
+
+
+=head1 SEE ALSO
+
+
+
+See funtools(n) for a list of Funtools help pages
+
+
+=cut