xtiffio.h File Reference

#include "tiffio.h"
#include "geo_config.h"

Go to the source code of this file.

Functions

void CPL_DLL XTIFFInitialize ()
TIFF CPL_DLL * XTIFFOpen (const char *name, const char *mode)
void CPL_DLL XTIFFClose (TIFF *tif)


Detailed Description

Definitions relating GeoTIFF functions from geotiff.h to the TIFF library (usually libtiff).

Function Documentation

void CPL_DLL XTIFFClose ( TIFF *  tif  ) 

Close a file opened with XTIFFOpen().

Parameters:
tif The file handle returned by XTIFFOpen().
If a GTIF structure was created with GTIFNew() for this file, it should be freed with GTIFFree() before calling XTIFFClose().

void CPL_DLL XTIFFInitialize ( void   ) 

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.

This function may be called any number of times safely, since it will only register the extension the first time it is called.

TIFF CPL_DLL* XTIFFOpen ( const char *  name,
const char *  mode 
)

GeoTIFF compatible TIFF file open function.

Parameters:
name The filename of a TIFF file to open.
mode The open mode ("r", "w" or "a").
Returns:
a TIFF * for the file, or NULL if the open failed.
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 XTIFFOpen() isn't used, GTIFNew() won't work properly. Files opened with XTIFFOpen() should be closed with XTIFFClose().

The name of the file to be opened should be passed as name, and an opening mode ("r", "w" or "a") acceptable to TIFFOpen() should be passed as the mode.

If XTIFFOpen() fails it will return NULL. Otherwise, normal TIFFOpen() error reporting steps will have already taken place.


Generated for libgeotiff by doxygen 1.5.5