diff --git a/functions/filesystem.xml b/functions/filesystem.xml index b6753b15c0..15d1cb32ed 100644 --- a/functions/filesystem.xml +++ b/functions/filesystem.xml @@ -1,5 +1,5 @@ - + Filesystem functions Filesystem @@ -1366,25 +1366,35 @@ $fp = fopen ("c:\\data\\info.txt", "r"); - Reads to EOF on the given file pointer and writes the results to - standard output. + Reads to EOF on the given file pointer from the current position and + writes the results to standard output. If an error occurs, fpassthru returns &false;. - The file pointer must be valid, and must point to a file - successfully opened by fopen, - popen, or fsockopen. - The file is closed when fpassthru is done - reading it (leaving fp useless). + The file pointer must be valid, and must point to a file successfully + opened by fopen, popen, or + fsockopen. You may need to call + rewind to reset the file pointer to the beginning of + the file if you have already written data to the file. The file is + closed when fpassthru is done reading it (leaving + fp useless). If you just want to dump the contents of a file to stdout you may want to use the readfile, which saves you the fopen call. + + + When using fpassthru on a binary file on Windows + systems, you should make sure to open the file in binary mode by + appending a b to the mode used in the call to + fopen. + + See also readfile, fopen, popen, and