lib/libcurses/curses_fileio.3

   1 .\"     $NetBSD: curses_fileio.3,v 1.4 2010/12/09 11:21:49 njoly Exp $
   2 .\" Copyright (c) 2008 The NetBSD Foundation, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to The NetBSD Foundation
   6 .\" by Julian Coleman.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  17 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  18 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  20 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 .\" POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .Dd March 31, 2008
  29 .Dt CURSES_FILEIO 3
  30 .Os
  31 .Sh NAME
  32 .Nm curses_fileio ,
  33 .Nm getwin ,
  34 .Nm putwin
  35 .Nd curses file input/output routines
  36 .Sh LIBRARY
  37 .Lb libcurses
  38 .Sh SYNOPSIS
  39 .In curses.h
  40 .Ft WINDOW *
  41 .Fn getwin "FILE *fp"
  42 .Ft int
  43 .Fn putwin "WINDOW *win" "FILE *fp"
  44 .Sh DESCRIPTION
  45 These functions read and write data to and from files.
  46 .Pp
  47 The
  48 .Fn getwin
  49 function reads window data that has been stored in the file to which
  50 .Fa fp
  51 points, and then creates a new window using that data.
  52 .Pp
  53 The
  54 .Fn putwin
  55 function writes window data from the window
  56 .Fa win
  57 to the file pointed to by
  58 .Fa fp .
  59 .Sh RETURN VALUES
  60 The
  61 .Fn getwin
  62 function returns one of the following values:
  63 .Pp
  64 .Bl -tag -width ERR -compact
  65 .It Er OK
  66 The function completed successfully.
  67 .It Er ERR
  68 An error occurred in the function.
  69 .El
  70 .Pp
  71 The
  72 .Fn putwin
  73 function returns
  74 .Dv NULL
  75 if an error is detected.
  76 .Sh SEE ALSO
  77 .Xr curses_window 3 ,
  78 .Xr fread 3 ,
  79 .Xr fwrite 3
  80 .Sh NOTES
  81 Subwindows can not be created by the
  82 .Fn getwin
  83 function, nor written by the
  84 .Fn putwin
  85 function.
  86 .Sh STANDARDS
  87 The
  88 .Nx
  89 Curses library complies with the X/Open Curses specification, part of the
  90 Single Unix Specification.
  91 .Sh HISTORY
  92 These functions first appeared in
  93 .Nx 5.0 .