<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libgeotiff: xtiffio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xtiffio.h File Reference</h1><code>#include "tiffio.h"</code><br>
<code>#include "geo_config.h"</code><br>
<p>
<a href="xtiffio_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void CPL_DLL </td><td class="memItemRight" valign="bottom"><a class="el" href="xtiffio_8h.html#670c1fbcfd377adea5be6e99181fbf2c">XTIFFInitialize</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TIFF CPL_DLL * </td><td class="memItemRight" valign="bottom"><a class="el" href="xtiffio_8h.html#0191e91b25f6a5f3f00806be37bf96c4">XTIFFOpen</a> (const char *name, const char *mode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void CPL_DLL </td><td class="memItemRight" valign="bottom"><a class="el" href="xtiffio_8h.html#9fa88015726dd9c805368e7623d7e86a">XTIFFClose</a> (TIFF *tif)</td></tr>
</table>
<hr><h2>Detailed Description</h2>
Definitions relating GeoTIFF functions from <a class="el" href="geotiff_8h.html">geotiff.h</a> to the TIFF library (usually libtiff). <hr><h2>Function Documentation</h2>
<a class="anchor" name="9fa88015726dd9c805368e7623d7e86a"></a><!-- doxytag: member="xtiffio.h::XTIFFClose" ref="9fa88015726dd9c805368e7623d7e86a" args="(TIFF *tif)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPL_DLL XTIFFClose </td>
<td>(</td>
<td class="paramtype">TIFF * </td>
<td class="paramname"> <em>tif</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close a file opened with <a class="el" href="xtiffio_8h.html#0191e91b25f6a5f3f00806be37bf96c4">XTIFFOpen()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tif</em> </td><td>The file handle returned by <a class="el" href="xtiffio_8h.html#0191e91b25f6a5f3f00806be37bf96c4">XTIFFOpen()</a>.</td></tr>
</table>
</dl>
If a GTIF structure was created with <a class="el" href="geotiff_8h.html#67d3b43f2a73c0129f8346804e2d038c">GTIFNew()</a> for this file, it should be freed with <a class="el" href="geotiff_8h.html#c9c0043c33ec4e16361d61e1ed79e96f">GTIFFree()</a> <em>before</em> calling <a class="el" href="xtiffio_8h.html#9fa88015726dd9c805368e7623d7e86a">XTIFFClose()</a>.
</div>
</div><p>
<a class="anchor" name="670c1fbcfd377adea5be6e99181fbf2c"></a><!-- doxytag: member="xtiffio.h::XTIFFInitialize" ref="670c1fbcfd377adea5be6e99181fbf2c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPL_DLL XTIFFInitialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Registers an extension with libtiff for adding GeoTIFF tags. After this one-time intialization, any TIFF open function may be called in the usual manner to create a TIFF file that compatible with libgeotiff. The XTIFF open functions are simply for convenience: they call this and then pass their parameters on to the appropriate TIFF open function.<p>
This function may be called any number of times safely, since it will only register the extension the first time it is called.
</div>
</div><p>
<a class="anchor" name="0191e91b25f6a5f3f00806be37bf96c4"></a><!-- doxytag: member="xtiffio.h::XTIFFOpen" ref="0191e91b25f6a5f3f00806be37bf96c4" args="(const char *name, const char *mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TIFF CPL_DLL* XTIFFOpen </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
GeoTIFF compatible TIFF file open function.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The filename of a TIFF file to open. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The open mode ("r", "w" or "a").</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a TIFF * for the file, or NULL if the open failed.</dd></dl>
This function is used to open GeoTIFF files instead of TIFFOpen() from libtiff. Internally it calls TIFFOpen(), but sets up some extra hooks so that GeoTIFF tags can be extracted from the file. If <a class="el" href="xtiffio_8h.html#0191e91b25f6a5f3f00806be37bf96c4">XTIFFOpen()</a> isn't used, <a class="el" href="geotiff_8h.html#67d3b43f2a73c0129f8346804e2d038c">GTIFNew()</a> won't work properly. Files opened with <a class="el" href="xtiffio_8h.html#0191e91b25f6a5f3f00806be37bf96c4">XTIFFOpen()</a> should be closed with <a class="el" href="xtiffio_8h.html#9fa88015726dd9c805368e7623d7e86a">XTIFFClose()</a>.<p>
The name of the file to be opened should be passed as <b>name</b>, and an opening mode ("r", "w" or "a") acceptable to TIFFOpen() should be passed as the <b>mode</b>.<p>
If <a class="el" href="xtiffio_8h.html#0191e91b25f6a5f3f00806be37bf96c4">XTIFFOpen()</a> fails it will return NULL. Otherwise, normal TIFFOpen() error reporting steps will have already taken place.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for libgeotiff by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.5.9</small></address>
</body>
</html>
