228 lines
9.9 KiB
HTML
228 lines
9.9 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
<meta name="Content-Style" content="text/css">
|
|
<title>TIFFSetField</title>
|
|
</head>
|
|
<body>
|
|
|
|
<h1 align=center>TIFFSetField</h1>
|
|
<a href="#NAME">NAME</a><br>
|
|
<a href="#SYNOPSIS">SYNOPSIS</a><br>
|
|
<a href="#DESCRIPTION">DESCRIPTION</a><br>
|
|
<a href="#RETURN VALUES">RETURN VALUES</a><br>
|
|
<a href="#RETURN VALUES">RETURN VALUES</a><br>
|
|
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
|
|
<a href="#SEE ALSO">SEE ALSO</a><br>
|
|
|
|
<hr>
|
|
<!-- Creator : groff version 1.17.2 -->
|
|
<!-- CreationDate: Thu Nov 27 17:58:04 2003 -->
|
|
<a name="NAME"></a>
|
|
<h2>NAME</h2>
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
TIFFSetField - set the value(s) of a tag in a <small>TIFF</small> file open for writing</td></table>
|
|
<a name="SYNOPSIS"></a>
|
|
<h2>SYNOPSIS</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<b>#include <tiffio.h><br>
|
|
int TIFFSetField(TIFF* tif, ttag_t tag, ...)<br>
|
|
#include <stdarg.h><br>
|
|
int TIFFVSetField(TIFF* tif, ttag_t tag, va_list
|
|
ap)</b></td></table>
|
|
<a name="DESCRIPTION"></a>
|
|
<h2>DESCRIPTION</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<i>TIFFSetField</i> sets the value of a field or pseudo-tag
|
|
in the current directory associated with the open
|
|
<small>TIFF</small> file <i>tif</i>. (A <i>pseudo-tag</i> 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.) To set the value of a field
|
|
the file must have been previously opened for writing with
|
|
<i>TIFFOpen</i>(3T); pseudo-tags can be set whether the file
|
|
was opened for reading or writing. The field is identified
|
|
by <i>tag</i>, one of the values defined in the include file
|
|
<b>tiff.h</b> (see also the table below). The actual value
|
|
is specified using a variable argument list, as prescribed
|
|
by the <i>stdarg</i>(3) interface (or, on some machines, the
|
|
<i>varargs</i>(3) interface.)</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<i>TIFFVSetField</i> is functionally equivalent to
|
|
<i>TIFFSetField</i> except that it takes a pointer to a
|
|
variable argument list. <i>TIFFVSetField</i> is useful for
|
|
writing routines that are layered on top of the
|
|
functionality provided by <i>TIFFSetField</i>.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
The tags understood by <i>libtiff</i>, the number of
|
|
parameter values, and the expected types for the parameter
|
|
values are shown below. The data types are: <i>char*</i> is
|
|
null-terminated string and corresponds to the
|
|
<small>ASCII</small> data type; <i>uint16</i> is an unsigned
|
|
16-bit value; <i>uint32</i> is an unsigned 32-bit value;
|
|
<i>uint16*</i> is an array of unsigned 16-bit values.
|
|
<i>void*</i> is an array of data values of unspecified
|
|
type.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
Consult the <small>TIFF</small> specification for
|
|
information on the meaning of each tag.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<pre>
|
|
<i>Tag Name Count Types Notes
|
|
|
|
</i>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_DATETIME 1 char*
|
|
TIFFTAG_DOCUMENTNAME 1 char*
|
|
TIFFTAG_DOTRANGE 2 uint16
|
|
TIFFTAG_EXTRASAMPLES 2 uint16,uint16* count & 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_IMAGEDESCRIPTION 1 char*
|
|
TIFFTAG_IMAGEDEPTH 1 uint32
|
|
TIFFTAG_IMAGELENGTH 1 uint32
|
|
TIFFTAG_IMAGEWIDTH 1 uint32
|
|
TIFFTAG_INKNAMES 1 char*
|
|
TIFFTAG_INKSET 1 uint16
|
|
TIFFTAG_JPEGTABLES 2 uint32*,void* count & 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_PRIMARYCHROMATICITIES 1 float* 6-entry array
|
|
TIFFTAG_REFERENCEBLACKWHITE 1 float* 2*SamplesPerPixel array
|
|
TIFFTAG_RESOLUTIONUNIT 1 uint16
|
|
TIFFTAG_ROWSPERSTRIP 1 uint32 must be > 0
|
|
TIFFTAG_SAMPLEFORMAT 1 uint16
|
|
TIFFTAG_SAMPLESPERPIXEL 1 uint16 value must be <= 4
|
|
TIFFTAG_SMAXSAMPLEVALUE 1 double
|
|
TIFFTAG_SMINSAMPLEVALUE 1 double
|
|
TIFFTAG_SOFTWARE 1 char*
|
|
TIFFTAG_STONITS 1 double
|
|
TIFFTAG_SUBFILETYPE 1 uint32
|
|
TIFFTAG_SUBIFD 2 uint16,uint32* count & offsets array
|
|
TIFFTAG_TARGETPRINTER 1 char*
|
|
TIFFTAG_THRESHHOLDING 1 uint16
|
|
TIFFTAG_TILEDEPTH 1 uint32
|
|
TIFFTAG_TILELENGTH 1 uint32 must be a multiple of 8
|
|
TIFFTAG_TILEWIDTH 1 uint32 must be a multiple of 8
|
|
TIFFTAG_TRANSFERFUNCTION 1 or 3 uint16* 1<<BitsPerSample entry arrays
|
|
TIFFTAG_XPOSITION 1 float
|
|
TIFFTAG_XRESOLUTION 1 float
|
|
TIFFTAG_WHITEPOINT 1 float* 2-entry array
|
|
TIFFTAG_YCBCRCOEFFICIENTS 1 float* 3-entry array
|
|
TIFFTAG_YCBCRPOSITIONING 1 uint16
|
|
TIFFTAG_YCBCRSAMPLING 2 uint16
|
|
TIFFTAG_YPOSITION 1 float
|
|
TIFFTAG_YRESOLUTION 1 float
|
|
TIFFTAG_ICCPROFILE 2 uint32,void* count, profile data*
|
|
</pre>Tag may not have its values changed once data is written.<br>
|
|
If <i>SamplesPerPixel</i> is one, then a single array is passed; otherwise three arrays should be passed.<br>
|
|
* The contents of this field are quite complex. See <i>The ICC Profile Format Specification</i>, Annex B.3 "Embedding ICC Profiles in TIFF Files" (available at http://www.color.org) for an explanation.</td></table>
|
|
<a name="RETURN VALUES"></a>
|
|
<h2>RETURN VALUES</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
1 is returned if the tag is defined in the current
|
|
directory; otherwise a 0 is returned.</td></table>
|
|
<a name="RETURN VALUES"></a>
|
|
<h2>RETURN VALUES</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
1 is returned if the operation was successful. Otherwise, 0
|
|
is returned if an error was detected.</td></table>
|
|
<a name="DIAGNOSTICS"></a>
|
|
<h2>DIAGNOSTICS</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
All error messages are directed to the <i>TIFFError</i>(3T)
|
|
routine.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<b>%s: Cannot modify tag "%s" while writing</b>.
|
|
Data has already been written to the file, so the specified
|
|
tag's value can not be changed. This restriction is applied
|
|
to all tags that affect the format of written
|
|
data.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<b>%d: Bad value for "%s"</b>. An invalid value
|
|
was supplied for the named tag.</td></table>
|
|
<a name="SEE ALSO"></a>
|
|
<h2>SEE ALSO</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
|
|
<i>TIFFGetField</i>(3T), <i>TIFFSetDirectory</i>(3T),
|
|
<i>TIFFWriteDirectory</i>(3T),
|
|
<i>TIFFReadDirectory</i>(3T)</td></table>
|
|
<hr>
|
|
</body>
|
|
</html>
|