libixp

git clone git://oldgit.suckless.org/libixp/
Log | Files | Refs | LICENSE

ixp_read.3 (972B)

      1 .TH "IXP_READ" 3 "2010 Jun" "libixp Manual"
      2 
      3 .SH NAME
      4 .P
      5 ixp_read, ixp_pread
      6 
      7 .SH SYNOPSIS
      8 .nf
      9   #include <ixp.h>
     10   
     11   long ixp_read(IxpCFid *fid, void *buf, long count);
     12   
     13   long ixp_pread(IxpCFid *fid, void *buf, long count, int64_t offset);
     14 .fi
     15 
     16 .SH PARAMETERS
     17 .TP
     18 buf
     19 A buffer in which to store the read data.
     20 .TP
     21 count
     22 The number of bytes to read.
     23 .TP
     24 offset
     25 The offset at which to begin reading.
     26 
     27 .SH DESCRIPTION
     28 .P
     29 ixp_read and ixp_pread each read IcountR bytes of data
     30 from the file pointed to by IfidR, into IbufR. ixp_read
     31 begins reading at its stored offset, and increments it by
     32 the number of bytes read. ixp_pread reads beginning at
     33 IoffsetR and does not alter IfidR's stored offset.
     34 
     35 .SH RETURN VALUE
     36 .P
     37 These functions return the number of bytes read on
     38 success and \-1 on failure.
     39 
     40 .SH SEE ALSO
     41 .P
     42 ixp_mount(3), ixp_open(3), ixp_write(3)
     43 
     44 
     45 .\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
     46 .\" cmdline: txt2tags -o- ixp_read.man3
     47