summaryrefslogtreecommitdiff
path: root/pod/perlapio.pod
diff options
context:
space:
mode:
authorJarkko Hietaniemi <jhi@iki.fi>2002-07-11 15:41:32 +0000
committerJarkko Hietaniemi <jhi@iki.fi>2002-07-11 15:41:32 +0000
commitb9d6bf1307347f5c042490ec06edac847e8ada07 (patch)
tree9fe8792d4531acf8cf256f678ff5f1312bdf6eef /pod/perlapio.pod
parent6700e351e95075f6f63aa2e498858d6df40b447c (diff)
downloadperl-b9d6bf1307347f5c042490ec06edac847e8ada07.tar.gz
Document better the PerlIO_{export,release,import}FILE()
relationships (or the lack thereof). p4raw-id: //depot/perl@17485
Diffstat (limited to 'pod/perlapio.pod')
-rw-r--r--pod/perlapio.pod6
1 files changed, 6 insertions, 0 deletions
diff --git a/pod/perlapio.pod b/pod/perlapio.pod
index 9da7f2d3d6..1353ee0642 100644
--- a/pod/perlapio.pod
+++ b/pod/perlapio.pod
@@ -321,6 +321,8 @@ C<PerlIO_close()> on the returned PerlIO *.
The PerlIO is set to textmode. Use PerlIO_binmode if this is
not the desired mode.
+This is B<not> the reverse of PerlIO_exportFILE().
+
=item B<PerlIO_exportFILE(f,mode)>
Given a PerlIO * create a 'native' FILE * suitable for passing to code
@@ -334,6 +336,7 @@ pushing a new :stdio "layer" onto the PerlIO *), which may affect future
PerlIO operations on the original PerlIO *.
You should not call C<fclose()> on the file unless you call
C<PerlIO_releaseFILE()> to disassociate it from the PerlIO *.
+(And do not use PerlIO_importFILE() for doing to disassociation.)
Calling this function repeatedly will create a FILE * on each call
(and will push an :stdio layer each time as well).
@@ -344,6 +347,9 @@ Calling PerlIO_releaseFILE informs PerlIO that all use of FILE * is
complete. It is removed from the list of 'exported' FILE *s, and the
associated PerlIO * should revert to its original behaviour.
+Use this to disassociate a file from a PerlIO * that was associated
+using PerlIO_exportFILE().
+
=item B<PerlIO_findFILE(f)>
Returns a native FILE * used by a stdio layer. If there is none, it