Return to count_fopen.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libpdel / io

libpdel

    1: .\" Copyright (c) 2001-2002 Packet Design, LLC.
    2: .\" All rights reserved.
    3: .\" 
    4: .\" Subject to the following obligations and disclaimer of warranty,
    5: .\" use and redistribution of this software, in source or object code
    6: .\" forms, with or without modifications are expressly permitted by
    7: .\" Packet Design; provided, however, that:
    8: .\" 
    9: .\"    (i)  Any and all reproductions of the source or object code
   10: .\"         must include the copyright notice above and the following
   11: .\"         disclaimer of warranties; and
   12: .\"    (ii) No rights are granted, in any manner or form, to use
   13: .\"         Packet Design trademarks, including the mark "PACKET DESIGN"
   14: .\"         on advertising, endorsements, or otherwise except as such
   15: .\"         appears in the above copyright notice or in the software.
   16: .\" 
   17: .\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
   18: .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
   19: .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
   20: .\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
   21: .\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
   22: .\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
   23: .\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
   24: .\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
   25: .\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
   26: .\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
   27: .\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
   28: .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
   29: .\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
   30: .\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
   31: .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   32: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
   33: .\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
   34: .\" THE POSSIBILITY OF SUCH DAMAGE.
   35: .\"
   36: .\" Author: Archie Cobbs <archie@freebsd.org>
   37: .\"
   38: .\" $Id: count_fopen.3,v 1.1.1.1 2012/02/21 23:25:53 misho Exp $
   39: .\"
   40: .Dd April 22, 2002
   41: .Dt COUNT_FOPEN 3
   42: .Os
   43: .Sh NAME
   44: .Nm count_fopen
   45: .Nd read a fixed number of bytes from a stream
   46: .Sh LIBRARY
   47: PDEL Library (libpdel, \-lpdel)
   48: .Sh SYNOPSIS
   49: .In sys/types.h
   50: .In stdio.h
   51: .In pdel/io/count_fp.h
   52: .Ft "FILE *"
   53: .Fn count_fopen "FILE *fp" "off_t count" "int closeit"
   54: .Sh DESCRIPTION
   55: .Fn count_fopen
   56: creates a new read-only stream that reads up to, but no more than,
   57: .Fa count
   58: bytes from the underlying stream
   59: .Fa fp .
   60: After
   61: .Fa count
   62: bytes have been read, further attempts to read from the returned stream
   63: will return
   64: .Dv EOF.
   65: .Pp
   66: .Xr fclose 3
   67: should be used to close the returned stream.
   68: The
   69: .Fa closeit
   70: parameter determines whether the underlying stream
   71: .Fa fp
   72: is closed when the returned stream is closed.
   73: .Sh RETURN VALUES
   74: .Fn boundary_fopen
   75: returns
   76: .Dv NULL
   77: to indicate an error, with
   78: .Va errno
   79: set appropriately.
   80: .Sh SEE ALSO
   81: .Xr boundary_fopen 3 ,
   82: .Xr string_fp 3 ,
   83: .Xr libpdel 3
   84: .Rs
   85: .%A N. Freed
   86: .%A N. Borenstein
   87: .%T "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"
   88: .%O RFC 2046
   89: .Re
   90: .Sh HISTORY
   91: The PDEL library was developed at Packet Design, LLC.
   92: .Dv "http://www.packetdesign.com/"
   93: .Sh AUTHORS
   94: .An Archie Cobbs Aq archie@freebsd.org