146 lines
3.2 KiB
HTML
146 lines
3.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of READFILE</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>READFILE</H1>
|
|
Section: GNU Awk Extension Modules (3am)<BR>Updated: Feb 02 2018<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
readfile - return the entire contents of a file as a string
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
@load "readfile"
|
|
<P>
|
|
result = readfile("/some/path")
|
|
<P>
|
|
|
|
For making whole files be single records:
|
|
<P>
|
|
|
|
@load "readfile"
|
|
<BR>
|
|
|
|
BEGIN { PROCINFO["readfile"] = 1 }
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<I>readfile</I>
|
|
|
|
extension adds a single function named
|
|
<B>readfile()</B>.
|
|
|
|
The argument is the name of the file to read.
|
|
The return value is a string containing the entire contents of
|
|
the requested file.
|
|
<P>
|
|
|
|
Upon error, the function returns the empty string and sets
|
|
<B>ERRNO</B>.
|
|
|
|
<P>
|
|
|
|
In addition, it adds an input parser that is activated if
|
|
|
|
PROCINFO["readfile"]
|
|
|
|
exists.
|
|
When activated, each input file is returned in its entirety as <TT>$0</TT>.
|
|
<TT>RT</TT> is set to the null string.
|
|
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>EXAMPLE</H2>
|
|
|
|
|
|
<PRE>
|
|
@load "readfile"
|
|
...
|
|
contents = readfile("/path/to/file");
|
|
if (contents == "" && ERRNO != "") {
|
|
print("problem reading file", ERRNO) > "/dev/stderr"
|
|
...
|
|
}
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<I>GAWK: Effective AWK Programming</I>,
|
|
|
|
<I>filefuncs</I>(3am),
|
|
|
|
<I>fnmatch</I>(3am),
|
|
|
|
<I>fork</I>(3am),
|
|
|
|
<I>inplace</I>(3am),
|
|
|
|
<I>ordchr</I>(3am),
|
|
|
|
<I>readdir</I>(3am),
|
|
|
|
<I>revoutput</I>(3am),
|
|
|
|
<I>rwarray</I>(3am),
|
|
|
|
<I>time</I>(3am).
|
|
|
|
<A NAME="lbAG"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
Arnold Robbins,
|
|
<B><A HREF="mailto:arnold@skeeve.com">arnold@skeeve.com</A></B>.
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>COPYING PERMISSIONS</H2>
|
|
|
|
Copyright © 2012, 2013, 2014, 2018,
|
|
Free Software Foundation, Inc.
|
|
<P>
|
|
|
|
Permission is granted to make and distribute verbatim copies of
|
|
this manual page provided the copyright notice and this permission
|
|
notice are preserved on all copies.
|
|
|
|
<P>
|
|
|
|
Permission is granted to copy and distribute modified versions of this
|
|
manual page under the conditions for verbatim copying, provided that
|
|
the entire resulting derived work is distributed under the terms of a
|
|
permission notice identical to this one.
|
|
<P>
|
|
|
|
Permission is granted to copy and distribute translations of this
|
|
manual page into another language, under the above conditions for
|
|
modified versions, except that this permission notice may be stated in
|
|
a translation approved by the Foundation.
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="4"><A HREF="#lbAE">EXAMPLE</A><DD>
|
|
<DT id="5"><A HREF="#lbAF">SEE ALSO</A><DD>
|
|
<DT id="6"><A HREF="#lbAG">AUTHOR</A><DD>
|
|
<DT id="7"><A HREF="#lbAH">COPYING PERMISSIONS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:54 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|