contrib/libpcap/pcap_dump_ftell.3pcap

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_DUMP_FTELL 3PCAP "3 January 2014"
  21 .SH NAME
  22 pcap_dump_ftell, pcap_dump_ftell64 \- get the current file offset for a savefile being written
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 long pcap_dump_ftell(pcap_dumper_t *p);
  31 .ft B
  32 int64_t pcap_dump_ftell64(pcap_dumper_t *p);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_dump_ftell()
  37 returns the current file position for the ``savefile'', representing the
  38 number of bytes written by
  39 .B pcap_dump_open()
  40 and
  41 .BR pcap_dump() .
  42 \-1 is returned on error.
  43 If the current file position does not fit in a
  44 .BR long ,
  45 it will be truncated; this can happen on 32-bit UNIX-like systems with
  46 large file support and on Windows.
  47 .B pcap_dump_ftell64()
  48 returns the current file position in a
  49 .BR int64_t ,
  50 so if file offsets that don't fit in a
  51 .B long
  52 but that fit in a
  53 .B int64_t
  54 are supported, this will return the file offset without truncation.
  55 \-1 is returned on error.
  56 .SH SEE ALSO
  57 pcap(3PCAP), pcap_dump_open(3PCAP), pcap_dump(3PCAP)