|
Server : Apache/2.4.62 System : FreeBSD fbsdweb2.web.rcn.net 14.1-RELEASE FreeBSD 14.1-RELEASE releng/14.1-n267679-10e31f0946d8 GENERIC amd64 User : www ( 80) PHP Version : 8.3.8 Disable Function : NONE Directory : /usr/local/share/doc/tiff-4.6.0/manual/functions/ |
Upload File : |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>TIFFSetField — LibTIFF 4.6.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/sphinxdoc.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="TIFFSetTagExtender" href="TIFFSetTagExtender.html" />
<link rel="prev" title="TIFFSetDirectory" href="TIFFSetDirectory.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="TIFFSetTagExtender.html" title="TIFFSetTagExtender"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="TIFFSetDirectory.html" title="TIFFSetDirectory"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">LibTIFF 4.6.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../functions.html" accesskey="U">TIFF Functions Overview</a> »</li>
<li class="nav-item nav-item-this"><a href="">TIFFSetField</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="tiffsetfield">
<h1>TIFFSetField<a class="headerlink" href="#tiffsetfield" title="Permalink to this heading">¶</a></h1>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><tiffio.h></span>
<span class="cp">#include</span><span class="w"> </span><span class="cpf"><stdarg.h></span><span class="c1">"</span>
</pre></div>
</div>
<dl class="c function">
<dt class="sig sig-object c" id="c.TIFFSetField">
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TIFFSetField</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TIFF</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">tif</span></span>, <span class="n"><span class="pre">ttag_t</span></span><span class="w"> </span><span class="n"><span class="pre">tag</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.TIFFSetField" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.TIFFVSetField">
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TIFFVSetField</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TIFF</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">tif</span></span>, <span class="n"><span class="pre">ttag_t</span></span><span class="w"> </span><span class="n"><span class="pre">tag</span></span>, <span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">ap</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.TIFFVSetField" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.TIFFUnsetField">
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TIFFUnsetField</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TIFF</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">tif</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n"><span class="pre">tag</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.TIFFUnsetField" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
<p><a class="reference internal" href="#c.TIFFSetField" title="TIFFSetField"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFSetField()</span></code></a> sets the value of a field or pseudo-tag in the
current directory associated with the open TIFF file <em>tif</em>.
(A <em>pseudo-tag</em> is a parameter that is used to control the operation of
the TIFF 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 <a class="reference internal" href="TIFFOpen.html#c.TIFFOpen" title="TIFFOpen"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFOpen()</span></code></a>.
Pseudo-tags can be set whether the file was opened for reading or writing.
The field is identified by <em>tag</em>, one of the values defined in the include
file <code class="file docutils literal notranslate"><span class="pre">tiff.h</span></code> (see also the table below).
The actual value is specified using a variable argument list, as
prescribed by the <code class="file docutils literal notranslate"><span class="pre">stdarg.h</span></code> interface.</p>
<p><a class="reference internal" href="#c.TIFFVSetField" title="TIFFVSetField"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFVSetField()</span></code></a> is functionally equivalent to <a class="reference internal" href="#c.TIFFSetField" title="TIFFSetField"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFSetField()</span></code></a>
except that it takes a pointer to a variable argument list.
<a class="reference internal" href="#c.TIFFVSetField" title="TIFFVSetField"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFVSetField()</span></code></a> is useful for writing routines that are layered on
top of the functionality provided by <a class="reference internal" href="#c.TIFFSetField" title="TIFFSetField"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFSetField()</span></code></a>.</p>
<p><a class="reference internal" href="#c.TIFFUnsetField" title="TIFFUnsetField"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFUnsetField()</span></code></a> clears the contents of the field in the internal
structure. If it is a custom field, it is removed from the list of known tags.</p>
<p>The tags understood by <strong class="program">libtiff</strong>, the number of parameter values,
and the expected types for the parameter values are shown below.
The data types are:</p>
<table class="docutils align-default" id="id1">
<caption><span class="caption-text">Tag data types</span><a class="headerlink" href="#id1" title="Permalink to this table">¶</a></caption>
<colgroup>
<col style="width: 25.0%" />
<col style="width: 75.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td><p>a null-terminated string corresponding to the <code class="docutils literal notranslate"><span class="pre">ASCII</span></code> data type</p></td>
</tr>
<tr class="row-odd"><td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>an unsigned 16-bit value</p></td>
</tr>
<tr class="row-even"><td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>an unsigned 32-bit value;</p></td>
</tr>
<tr class="row-odd"><td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span><span class="p">*</span></span></p></td>
<td><p>an array of unsigned 16-bit values.</p></td>
</tr>
<tr class="row-even"><td><p><span class="c-expr sig sig-inline c"><span class="kt">void</span><span class="p">*</span></span></p></td>
<td><p>an array of data values of unspecified type.</p></td>
</tr>
</tbody>
</table>
<p>Consult the TIFF specification for information on the meaning of each tag.</p>
<blockquote>
<div><table class="docutils align-default" id="id2">
<caption><span class="caption-text">Tag properties</span><a class="headerlink" href="#id2" title="Permalink to this table">¶</a></caption>
<colgroup>
<col style="width: 21.7%" />
<col style="width: 13.0%" />
<col style="width: 21.7%" />
<col style="width: 43.5%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Tag name</p></th>
<th class="head"><p>Count</p></th>
<th class="head"><p>Types</p></th>
<th class="head"><p>Notes</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_ARTIST</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_BADFAXLINES</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_BITSPERSAMPLE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_CLEANFAXDATA</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_COLORMAP</span></code></p></td>
<td><p>3</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span><span class="p">*</span></span></p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="m">1</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">BitsPerSample</span></span> arrays</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_COMPRESSION</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_CONSECUTIVEBADFAXLINES</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_COPYRIGHT</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_DATETIME</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_DOCUMENTNAME</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_DOTRANGE</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_EXTRASAMPLES</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span>, <span class="c-expr sig sig-inline c"><span class="n">uint16_t</span><span class="p">*</span></span></p></td>
<td><p>† count, types array</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_FAXFILLFUNC</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">TIFFFaxFillFunc</span></span></p></td>
<td><p>G3/G4 compression pseudo-tag</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_FAXMODE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">int</span></span></p></td>
<td><p>† G3/G4 compression pseudo-tag</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_FILLORDER</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_GROUP3OPTIONS</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_GROUP4OPTIONS</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_HALFTONEHINTS</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_HOSTCOMPUTER</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_ICCPROFILE</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span>, <span class="c-expr sig sig-inline c"><span class="kt">void</span><span class="p">*</span></span></p></td>
<td><p>count, profile data*</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_IMAGEDEPTH</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_IMAGEDESCRIPTION</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_IMAGELENGTH</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_IMAGEWIDTH</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_INKNAMES</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span>, <span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_INKSET</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_JPEGCOLORMODE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">int</span></span></p></td>
<td><p>† JPEG pseudo-tag</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_JPEGQUALITY</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">int</span></span></p></td>
<td><p>JPEG pseudo-tag</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_JPEGTABLES</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span><span class="p">*</span></span>, <span class="c-expr sig sig-inline c"><span class="kt">void</span><span class="p">*</span></span></p></td>
<td><p>† count, tables</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_JPEGTABLESMODE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">int</span></span></p></td>
<td><p>† JPEG pseudo-tag</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_MAKE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_MATTEING</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_MAXSAMPLEVALUE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_MINSAMPLEVALUE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_MODEL</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_ORIENTATION</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_PAGENAME</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_PAGENUMBER</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_PHOTOMETRIC</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_PHOTOSHOP</span></code></p></td>
<td><p>?</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span>, <span class="c-expr sig sig-inline c"><span class="kt">void</span><span class="p">*</span></span></p></td>
<td><p>count, data</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_PLANARCONFIG</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_PREDICTOR</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_PRIMARYCHROMATICITIES</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span><span class="p">*</span></span></p></td>
<td><p>6-entry array</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_REFERENCEBLACKWHITE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span><span class="p">*</span></span></p></td>
<td><p>† 6-entry array</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_RESOLUTIONUNIT</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_RICHTIFFIPTC</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span>, <span class="c-expr sig sig-inline c"><span class="kt">void</span><span class="p">*</span></span></p></td>
<td><p>count, data</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_ROWSPERSTRIP</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>† must be > 0</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_SAMPLEFORMAT</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_SAMPLESPERPIXEL</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>† value must be ≤ 4</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_SMAXSAMPLEVALUE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">double</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_SMINSAMPLEVALUE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">double</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_SOFTWARE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_STONITS</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">double</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_SUBFILETYPE</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_SUBIFD</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span>, <span class="c-expr sig sig-inline c"><span class="n">uint64_t</span><span class="p">*</span></span></p></td>
<td><p>count, offsets array</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_TARGETPRINTER</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">char</span><span class="p">*</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_THRESHHOLDING</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_TILEDEPTH</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_TILELENGTH</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>† must be a multiple of 8</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_TILEWIDTH</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span></p></td>
<td><p>† must be a multiple of 8</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_TRANSFERFUNCTION</span></code></p></td>
<td><p>1 or 3‡</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span><span class="p">*</span></span></p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="m">1</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="n">BitsPerSample</span></span> entry arrays</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_WHITEPOINT</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span><span class="p">*</span></span></p></td>
<td><p>2-entry array</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_XMLPACKET</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint32_t</span></span>, <span class="c-expr sig sig-inline c"><span class="kt">void</span><span class="p">*</span></span></p></td>
<td><p>count, data</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_XPOSITION</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span></span></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_XRESOLUTION</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_YCBCRCOEFFICIENTS</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span><span class="p">*</span></span></p></td>
<td><p>† 3-entry array</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_YCBCRPOSITIONING</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_YCBCRSAMPLING</span></code></p></td>
<td><p>2</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="n">uint16_t</span></span></p></td>
<td><p>†</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_YPOSITION</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span></span></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref c c-macro docutils literal notranslate"><span class="pre">TIFFTAG_YRESOLUTION</span></code></p></td>
<td><p>1</p></td>
<td><p><span class="c-expr sig sig-inline c"><span class="kt">float</span></span></p></td>
<td></td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="simple">
<dt>†:</dt><dd><p>Tag may not have its values changed once data is written.</p>
</dd>
</dl>
<p>‡:</p>
<blockquote>
<div><p>If <code class="docutils literal notranslate"><span class="pre">SamplesPerPixel</span></code> is one, then a single array is passed;
otherwise three arrays should be passed.</p>
</div></blockquote>
<dl class="simple">
<dt>*:</dt><dd><p>The contents of this field are quite complex. See
“The ICC Profile Format Specification”,
Annex B.3 “Embedding ICC Profiles in TIFF Files”
(available at <a class="reference external" href="http://www.color.org">http://www.color.org</a>) for an explanation.</p>
</dd>
</dl>
</section>
<section id="return-values">
<h2>Return values<a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
<p>1 is returned if the operation was successful.
Otherwise, 0 is returned if an error was detected.</p>
</section>
<section id="diagnostics">
<h2>Diagnostics<a class="headerlink" href="#diagnostics" title="Permalink to this heading">¶</a></h2>
<p>All error messages are directed to the <a class="reference internal" href="TIFFError.html#c.TIFFErrorExtR" title="TIFFErrorExtR"><code class="xref c c-func docutils literal notranslate"><span class="pre">TIFFErrorExtR()</span></code></a> routine.</p>
<p><code class="docutils literal notranslate"><span class="pre">%s:</span> <span class="pre">Cannot</span> <span class="pre">modify</span> <span class="pre">tag</span> <span class="pre">"%s"</span> <span class="pre">while</span> <span class="pre">writing</span></code>:</p>
<blockquote>
<div><p>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.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">%d:</span> <span class="pre">Bad</span> <span class="pre">value</span> <span class="pre">for</span> <span class="pre">"%s"</span></code>:</p>
<blockquote>
<div><p>An invalid value was supplied for the named tag.</p>
</div></blockquote>
</section>
<section id="see-also">
<h2>See also<a class="headerlink" href="#see-also" title="Permalink to this heading">¶</a></h2>
<p><a class="reference internal" href="TIFFOpen.html"><span class="doc">TIFFOpen</span></a> (3tiff),
<a class="reference internal" href="TIFFGetField.html"><span class="doc">TIFFGetField</span></a> (3tiff),
<a class="reference internal" href="TIFFSetDirectory.html"><span class="doc">TIFFSetDirectory</span></a> (3tiff),
<a class="reference internal" href="TIFFWriteDirectory.html"><span class="doc">TIFFWriteDirectory</span></a> (3tiff),
<a class="reference internal" href="TIFFReadDirectory.html"><span class="doc">TIFFReadDirectory</span></a> (3tiff),
<a class="reference internal" href="libtiff.html"><span class="doc">libtiff</span></a> (3tiff)</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">TIFFSetField</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#return-values">Return values</a></li>
<li><a class="reference internal" href="#diagnostics">Diagnostics</a></li>
<li><a class="reference internal" href="#see-also">See also</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="TIFFSetDirectory.html"
title="previous chapter">TIFFSetDirectory</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="TIFFSetTagExtender.html"
title="next chapter">TIFFSetTagExtender</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/functions/TIFFSetField.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="TIFFSetTagExtender.html" title="TIFFSetTagExtender"
>next</a> |</li>
<li class="right" >
<a href="TIFFSetDirectory.html" title="TIFFSetDirectory"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">LibTIFF 4.6.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../functions.html" >TIFF Functions Overview</a> »</li>
<li class="nav-item nav-item-this"><a href="">TIFFSetField</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 1988-2022, LibTIFF contributors.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
</div>
</body>
</html>