"http://www.w3.org/TR/html4/loose.dtd">

<meta content="groff -Thtml, see www.gnu.org" name="generator">

<meta content="text/html; charset=US-ASCII" http-equiv="Content-Type">

<meta content="text/css" name="Content-Style">

<style type="text/css"></style>

       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }

       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }

       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }

       h1      { text-align: center }

<title>TIFFGetField</title>

TIFFGetField

NAME

SYNOPSIS

DESCRIPTION

AUTOREGISTERED TAGS

RETURN VALUES

DIAGNOSTICS

SEE ALSO

NAME

TIFFGetField,

TIFFVGetField − get the value(s) of a tag in an open

<small>TIFF</small> file

SYNOPSIS

#include

<tiffio.h>

int

TIFFGetField(TIFF *tif, ttag_t

tag, ...)

#include

<stdarg.h>

int

TIFFVGetField(TIFF *tif, ttag_t

tag, va_list ap) 

int TIFFGetFieldDefaulted(TIFF *tif,

ttag_t tag, ...) 

int TIFFVGetFieldDefaulted(TIFF *tif,

ttag_t tag, va_list ap)

DESCRIPTION

TIFFGetField

returns the value of a tag or pseudo-tag associated with the

the current directory of the opened <small>TIFF</small> file

tif. (A pseudo-tag is a parameter that is used

to control the operation of the <small>TIFF</small> library

but whose value is not read or written to the underlying

file.) The file must have been previously opened with

TIFFOpen(3TIFF). The tag is identified by tag,

one of the values defined in the include file tiff.h

(see also the table below). The type and number of values

returned is dependent on the tag being requested. The

programming interface uses a variable argument list as

prescribed by the stdarg(3) interface. The returned

values should only be interpreted if TIFFGetField

returns 1.

TIFFVGetField

is functionally equivalent to TIFFGetField except

that it takes a pointer to a variable argument list.

TIFFVGetField is useful for layering interfaces on

top of the functionality provided by

TIFFGetField.

TIFFGetFieldDefaulted

and TIFFVGetFieldDefaulted are identical to

TIFFGetField and TIFFVGetField, except that if

a tag is not defined in the current directory and it has a

default value, then the default value is returned.

The tags

understood by libtiff(3TIFF), the number of parameter

values, and the types for the returned values are shown

below. The data types are specified as in C and correspond

to the types used to specify tag values to

TIFFSetField(3TIFF). Remember that

TIFFGetField returns parameter values, so all the

listed data types are pointers to storage where values

should be returned. Consult the <small>TIFF</small>

specification (or relevant industry specification) for

information on the meaning of each tag and their possible

values.

       cellspacing="0" cellpadding="0">

Tag Name

Count

Types

Notes

TIFFTAG_ARTIST

1

char**

TIFFTAG_BADFAXLINES

1

uint32*

TIFFTAG_BITSPERSAMPLE

1

uint16*

TIFFTAG_CLEANFAXDATA

1

uint16*

TIFFTAG_COLORMAP

3

uint16**

1<<BitsPerSample arrays

TIFFTAG_COMPRESSION

1

uint16*

TIFFTAG_CONSECUTIVEBADFAXLINES

1

uint32*

TIFFTAG_COPYRIGHT

1

char**

TIFFTAG_DATATYPE

1

uint16*

TIFFTAG_DATETIME

1

char**

TIFFTAG_DOCUMENTNAME

1

char**

TIFFTAG_DOTRANGE

2

uint16*

TIFFTAG_EXTRASAMPLES

2

uint16*,uint16**

count & types array

TIFFTAG_FAXFILLFUNC

1

TIFFFaxFillFunc*

G3/G4 compression pseudo-tag

TIFFTAG_FAXMODE

1

int*

G3/G4 compression pseudo-tag

TIFFTAG_FILLORDER

1

uint16*

TIFFTAG_GROUP3OPTIONS

1

uint32*

TIFFTAG_GROUP4OPTIONS

1

uint32*

TIFFTAG_HALFTONEHINTS

2

uint16*

TIFFTAG_HOSTCOMPUTER

1

char**

TIFFTAG_ICCPROFILE

2

uint32*,void**

count, profile data

TIFFTAG_IMAGEDEPTH

1

uint32*

TIFFTAG_IMAGEDESCRIPTION

1

char**

TIFFTAG_IMAGELENGTH

1

uint32*

TIFFTAG_IMAGEWIDTH

1

uint32*

TIFFTAG_INKNAMES

1

char**

TIFFTAG_INKSET

1

uint16*

TIFFTAG_JPEGCOLORMODE

1

int*

JPEG pseudo-tag

TIFFTAG_JPEGQUALITY

1

int*

JPEG pseudo-tag

TIFFTAG_JPEGTABLES

2

uint32*,void**

count & tables

TIFFTAG_JPEGTABLESMODE