173 lines
4.0 KiB
HTML
173 lines
4.0 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of RWARRAY</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>RWARRAY</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>
|
|
|
|
writea, reada - write and read gawk arrays to/from files
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
@load "rwarray"
|
|
<P>
|
|
ret = writea(file, array)
|
|
<BR>
|
|
|
|
ret = reada(file, array)
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<I>rwarray</I>
|
|
|
|
extension adds two functions named
|
|
<B>writea()</B>.
|
|
|
|
and
|
|
<B>reada()</B>,
|
|
|
|
as follows.
|
|
<DL COMPACT>
|
|
<DT id="1"><B>writea()</B>
|
|
|
|
<DD>
|
|
This function takes a string argument, which is the name of the
|
|
file to which dump the array, and the array itself as the second
|
|
argument.
|
|
<B>writea()</B>
|
|
|
|
understands multidimensional arrays.
|
|
It returns one on success, or zero upon failure.
|
|
<DT id="2"><B>reada()</B>
|
|
|
|
<DD>
|
|
is the inverse of
|
|
<B>writea()</B>;
|
|
|
|
it reads the file named as its first argument, filling in
|
|
the array named as the second argument. It clears the array
|
|
first.
|
|
Here too, the return value is one on success and zero upon failure.
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
The array created by
|
|
<B>reada()</B>
|
|
|
|
is identical to that written by
|
|
<B>writea()</B>
|
|
|
|
in the sense that the contents are the same. However, due
|
|
to implementation issues, the array traversal order of the recreated
|
|
array will likely be different from that of the original array.
|
|
As array traversal order in AWK is by default undefined, this is
|
|
not (technically) a problem. If you need to guarantee a particular
|
|
traversal order, use the array sorting features in
|
|
<I>gawk</I>
|
|
|
|
to do so.
|
|
<P>
|
|
|
|
The file contains binary data. All integral values are written
|
|
in network byte order.
|
|
However, double precision floating-point values are written as
|
|
native binary data. Thus, arrays containing only string data
|
|
can theoretically be dumped on systems with one byte order and
|
|
restored on systems with a different one, but this has not been tried.
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>EXAMPLE</H2>
|
|
|
|
|
|
<PRE>
|
|
@load "rwarray"
|
|
...
|
|
ret = writea("arraydump.bin", array)
|
|
...
|
|
ret = reada("arraydump.bin", array)
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAG"> </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>readfile</I>(3am),
|
|
|
|
<I>revoutput</I>(3am),
|
|
|
|
<I>time</I>(3am).
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
Arnold Robbins,
|
|
<B><A HREF="mailto:arnold@skeeve.com">arnold@skeeve.com</A></B>.
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H2>COPYING PERMISSIONS</H2>
|
|
|
|
Copyright © 2012, 2013, 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="3"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="6"><A HREF="#lbAE">NOTES</A><DD>
|
|
<DT id="7"><A HREF="#lbAF">EXAMPLE</A><DD>
|
|
<DT id="8"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
<DT id="9"><A HREF="#lbAH">AUTHOR</A><DD>
|
|
<DT id="10"><A HREF="#lbAI">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>
|