Misc. Reference Manual Pages TIFFGetField(3tiff)
NAME
TIFFGetField, TIFFVGetField, TIFFGetFieldDefaulted,TIFFVGetFieldDefaulted - get the value(s) of a tag in an
open TIFF fileSYNOPSIS
#include
int TIFFGetField(TIFF* tif, ttag_t tag, ...)
#include
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)TIFFGetField returns the value of a tag or pseudo-tag asso-
ciated with the current directory of the open TIFF file. Apseudo-tag is a parameter that is used to control the opera-
tion of the TIFF library but whose value is not read orwritten to the underlying file. The file must have been pre-
viously 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 valuesreturned is dependent on the tag being requested. The pro-
gramming 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 TIFFVGetField takes a pointer to a variableargument list. TIFFVGetField is useful for layering inter-
faces on top of the functionality provided by TIFFGetField.TIFFGetFieldDefaulted and TIFFVGetFieldDefaulted are identi-
cal to TIFFGetField and TIFFVGetField, except that if a tag is not defined in the current directory and has a default value, then the default value is returned. The tags understood by libtiff, 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 of the listed data types are pointers to storage where values should be returned. Consult the TIFF specification for information on the meaning of each tag and their possible values. SunOS 5.10 Last change: 05 Apr 2004 1 Misc. Reference Manual Pages TIFFGetField(3tiff) SunOS 5.10 Last change: 05 Apr 2004 2 Misc. Reference Manual Pages TIFFGetField(3tiff)___________________________________________________________________________________________________
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<
___________________________________________________________________________________________________
TIFFTAG_COMPRESSION 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_CONSECUTIVEBADFAXLINES 1 uint32*
___________________________________________________________________________________________________
TIFFTAG_DATATYPE 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_DATETIME 1 char**
___________________________________________________________________________________________________
TIFFTAG_DOCUMENTNAME 1 char**
___________________________________________________________________________________________________
TIFFTAG_DOTRANGE 2 uint16*
___________________________________________________________________________________________________
TIFFTAG_EXTRASAMPLES 2 uint16*,uint16** count and types array
___________________________________________________________________________________________________
TIFFTAG_FAXMODE 1 int* G3/G4 compression
___________________________________________________________________________________________________
pseudo-tag
___________________________________________________________________________________________________
TIFFTAG_FAXFILLFUNC 1 TIFFFaxFillFunc* 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_IMAGEDEPTH 1 uint32*
___________________________________________________________________________________________________
TIFFTAG_IMAGEDESCRIPTION 1 char**
___________________________________________________________________________________________________
TIFFTAG_IMAGELENGTH 1 uint32*
___________________________________________________________________________________________________
TIFFTAG_IMAGEWIDTH 1 uint32*
___________________________________________________________________________________________________
TIFFTAG_INKNAMES 1 char**
SunOS 5.10 Last change: 05 Apr 2004 3 Misc. Reference Manual Pages TIFFGetField(3tiff)___________________________________________________________________________________________________
TIFFTAG_INKSET 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_JPEGTABLES 2 u_short*,void** count and tables
___________________________________________________________________________________________________
TIFFTAG_JPEGQUALITY 1 int* JPEG pseudo-tag
___________________________________________________________________________________________________
TIFFTAG_JPEGCOLORMODE 1 int* JPEG pseudo-tag
___________________________________________________________________________________________________
TIFFTAG_JPEGTABLESMODE 1 int* JPEG pseudo-tag
___________________________________________________________________________________________________
TIFFTAG_MAKE 1 char**
___________________________________________________________________________________________________
TIFFTAG_MATTEING 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_MAXSAMPLEVALUE 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_MINSAMPLEVALUE 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_MODEL 1 char**
___________________________________________________________________________________________________
TIFFTAG_ORIENTATION 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_PAGENAME 1 char**
___________________________________________________________________________________________________
TIFFTAG_PAGENUMBER 2 uint16*
___________________________________________________________________________________________________
TIFFTAG_PHOTOMETRIC 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_PLANARCONFIG 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_PREDICTOR 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_PRIMARYCHROMACITIES 1 float** 6-entry array
___________________________________________________________________________________________________
TIFFTAG_REFERENCEBLACKWHITE 1 float** 2*SamplesPerPixel array
___________________________________________________________________________________________________
TIFFTAG_RESOLUTIONUNIT 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_ROWSPERSTRIP 1 uint32*
___________________________________________________________________________________________________
TIFFTAG_SAMPLEFORMAT 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_SAMPLESPERPIXEL 1 uint16*
___________________________________________________________________________________________________
TIFFTAG_SMAXSAMPLEVALUE 1 double*
___________________________________________________________________________________________________
TIFFTAG_SMINSAMPLEVALUE 1 double*
___________________________________________________________________________________________________
TIFFTAG_SOFTWARE 1 char**
___________________________________________________________________________________________________
TIFFTAG_STONITS 1 double**
SunOS 5.10 Last change: 05 Apr 2004 4 Misc. Reference Manual Pages TIFFGetField(3tiff)___________________________________________________________________________________________________
| TIFFTAG_STRIPBYTECOUNTS | 1 | uint32** | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_STRIPOFFSETS | 1 | uint32** | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_SUBFILETYPE | 1 | uint32* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_SUBIFD | 2 | uint16*,uint32**| count and offsets array |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_TARGETPRINTER | 1 | char** | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_THRESHOLDING | 1 | uint16* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_TILEBYTECOUNTS | 1 | uint32** | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_TILEDEPTH | 1 | uint32* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_TILELENGTH | 1 | uint32* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_TILEOFFSETS | 1 | uint32** | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_TILEWIDTH | 1 | uint32* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_TRANSFERFUNCTION | 1 or 3- | uint16** | 1<
| | | | arrays | |_______________________________|________________|__________________|______________________________|
| TIFFTAG_WHITEPOINT | 1 | float** | 2-entry array |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_XPOSITION | 1 | float* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_XRESOLUTION | 1 | float* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_YCBCRCOEFFICIENTS | 1 | float** | 3-entry array |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_YCBCRPOSITIONING | 1 | uint16* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_YCBCRSUBSAMPLING | 2 | uint16* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_YPOSITION | 1 | float* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_YRESOLUTION | 1 | float* | |
|_______________________________|________________|__________________|______________________________|
| TIFFTAG_ICCPROFILE | 2 | uint32*,void** | count, profile data= |
|_______________________________|________________|__________________|______________________________|
- If SamplesPerPixel is 1, then a sin-
gle array is returned. Otherwise, three arrays are returned. SunOS 5.10 Last change: 05 Apr 2004 5 Misc. Reference Manual Pages TIFFGetField(3tiff) = The contents of this field are quite complex. See The ICC Profile Format Specification, Annex B "EmbeddingICC Profiles in TIFF Files", avail-
able at http://www.color.org, for an explanation. DiagnosticsAll error messages are directed to the TIFFError(3tiff) rou-
tine.Unknown field, tag 0x%x.An unknown tag was supplied.
1 is returned if the tag is defined in the current direc-
tory. Otherwise, 0 is returned.See attributes(5) for descriptions of the following attri-
butes:____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | image/library/libtiff ||_____________________________|_____________________________|
| Interface stability | Uncommitted ||_____________________________|_____________________________|
libtiff(3), TIFFOpen(3tiff), TIFFSetField(3tiff), TIFFSetDirectory(3tiff), TIFFReadDirectory(3tiff), TIFFWriteDirectory(3tiff) This man page was originally written by Sam Leffler. Updated by Breda McColgan, Sun Microsystems Inc., 2004. SunOS 5.10 Last change: 05 Apr 2004 6