src/tiff/man/TIFFFieldTag.3tiff

   1 .\" $Id: TIFFFieldTag.3tiff,v 1.1 2012-07-29 15:45:30 tgl Exp $
   2 .\"
   3 .\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us>
   4 .\"
   5 .\" Permission to use, copy, modify, distribute, and sell this software and
   6 .\" its documentation for any purpose is hereby granted without fee, provided
   7 .\" that (i) the above copyright notices and this permission notice appear in
   8 .\" all copies of the software and related documentation, and (ii) the names of
   9 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  10 .\" publicity relating to the software without the specific, prior written
  11 .\" permission of Sam Leffler and Silicon Graphics.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  14 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  15 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  16 .\"
  17 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  18 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  19 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  20 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  21 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22 .\" OF THIS SOFTWARE.
  23 .\"
  24 .if n .po 0
  25 .TH TIFFFieldTag 3TIFF "July 26, 2012" "libtiff"
  26 .SH NAME
  27 TIFFFieldTag \- Get TIFF field tag value from field information
  28 .SH SYNOPSIS
  29 .B "#include <tiffio.h>"
  30 .sp
  31 .BI "uint32 TIFFFieldTag(const TIFFField* " fip ")"
  32 .SH DESCRIPTION
  33 .BR TIFFFieldTag
  34 returns the numeric tag value for a TIFF field.
  35 This can be compared to various constants exported by the
  36 .BR libtiff
  37 header files, such as
  38 .BR TIFFTAG_IMAGEWIDTH .
  39 .P
  40 .I fip
  41 is a field information pointer previously returned by
  42 .BR TIFFFindField ,
  43 .BR TIFFFieldWithTag ,
  44 or
  45 .BR TIFFFieldWithName .
  46 .br
  47 .SH "RETURN VALUES"
  48 .br
  49 .BR TIFFFieldTag
  50 returns an integer tag value.
  51 .br
  52 .SH "SEE ALSO"
  53 .BR libtiff (3TIFF),
  54 .PP
  55 Libtiff library home page:
  56 .BR http://www.remotesensing.org/libtiff/