X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8414a40c52191d4c7cfeea74df22d9d64cbec415..e3735e7a9f6df9c84ba53461e3e4e7e80ce0e6d6:/src/tiff/html/man/TIFFSetField.3tiff.html diff --git a/src/tiff/html/man/TIFFSetField.3tiff.html b/src/tiff/html/man/TIFFSetField.3tiff.html index ad938cda19..f160fedd15 100644 --- a/src/tiff/html/man/TIFFSetField.3tiff.html +++ b/src/tiff/html/man/TIFFSetField.3tiff.html @@ -1,14 +1,25 @@ - - + + + + + TIFFSetField + -

TIFFSetField

+ NAME
SYNOPSIS
DESCRIPTION
@@ -17,1346 +28,1838 @@ SEE ALSO

+ + +

NAME -

NAME

- - - - - -

TIFFSetField, TIFFVSetField − set the value(s) of a -tag in a TIFF file open for writing

+ + + +

TIFFSetField, +TIFFVSetField − set the value(s) of a tag in a +TIFF file open for writing

+ +

SYNOPSIS -

SYNOPSIS

- - - - - -

#include <tiffio.h>

- -

int TIFFSetField(TIFF *tif, ttag_t + + + +

#include +<tiffio.h>

+ +

int +TIFFSetField(TIFF *tif, ttag_t tag, ...)

- -

#include <stdarg.h>

- -

int TIFFVSetField(TIFF *tif, ttag_t + +

#include +<stdarg.h>

+ +

int +TIFFVSetField(TIFF *tif, ttag_t tag, va_list ap)

+ +

DESCRIPTION -

DESCRIPTION

- - - - - -

TIFFSetField sets the value of a field or -pseudo-tag in the current directory associated with the open -TIFF file tif. (A pseudo-tag 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 -TIFFOpen(3TIFF); pseudo-tags can be set whether the -file was opened for reading or writing. The field is -identified by tag, one of the values defined in the -include file tiff.h (see also the table below). The -actual value is specified using a variable argument list, as -prescribed by the stdarg(3) interface (or, on some -machines, the varargs(3) interface.)

- -

TIFFVSetField is functionally equivalent to -TIFFSetField except that it takes a pointer to a -variable argument list. TIFFVSetField is useful for -writing routines that are layered on top of the -functionality provided by TIFFSetField.

- -

The tags understood by libtiff, the number of -parameter values, and the expected types for the parameter -values are shown below. The data types are: char* is + + + + +

TIFFSetField +sets the value of a field or pseudo-tag in the current +directory associated with the open TIFF file +tif. (A pseudo-tag 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 TIFFOpen(3TIFF); +pseudo-tags can be set whether the file was opened for +reading or writing. The field is identified by tag, +one of the values defined in the include file tiff.h +(see also the table below). The actual value is specified +using a variable argument list, as prescribed by the +stdarg(3) interface (or, on some machines, the +varargs(3) interface.)

+ + +

TIFFVSetField +is functionally equivalent to TIFFSetField except +that it takes a pointer to a variable argument list. +TIFFVSetField is useful for writing routines that are +layered on top of the functionality provided by +TIFFSetField.

+ +

The tags +understood by libtiff, the number of parameter +values, and the expected types for the parameter values are +shown below. The data types are: char* is null-terminated string and corresponds to the ASCII data type; uint16 is an unsigned 16-bit value; uint32 is an unsigned 32-bit value; uint16* is an array of unsigned 16-bit values. void* is an array of data values of unspecified type.

- -

Consult the TIFF specification for -information on the meaning of each tag.

- -

Tag Name Count Types Notes

- - +

Consult the +TIFF specification for information on the +meaning of each tag.

+ +

- - + - + + - - +

Count

+ - - + + + - - + - + +

Notes

- - + - - + + - +

+ - - + + + + + + + - + + - - +

+ - - + + + - - + + + + + + - +

+ - - + + + - - + - +

†

- - + + + - + + + + + + - - +

uint16

+ - - + - + + - - +

+ - - + + + - + - - +

1<<BitsPerSample arrays

- - + - - + + - + +

+ - - + + + - + - - +

†

- - + - - + + - +

+ - - + + + - - + + + + - +

TIFFTAG_COPYRIGHT

+ + + + + + + + + - - + - - + + - +

+ - - + + + - - + + + + + + + + + + + + - +

char*

+ - - + - - + + - +

+ - - + + + - - + + + + + + - +

+ - - + + + - - + - + +

† count & types array

- - + - + + - - +

+ - - + + + - - + - +

G3/G4 compression pseudo-tag

- - + - - + + - +

+ - - + + + - + - - +

† G3/G4 compression pseudo-tag

- - + - - + + - + +

+ - - + + + - - + - +

†

- - + - + + - - +

+ - - + + + - - + - +

†

- - + - - + + - +

+ - - + + + - - + - +

†

- - + - + + - - + + + + + + +

uint16

+ - - + - - + + - +

+ - - + + + - - + + + + - + +

TIFFTAG_ICCPROFILE

+ + + - - + + + - - + - +

count, profile data

- - + - - + + - + +

+ - - + + + - + - - +

†

- - + - + + - - +

+ - - + + + - - + + + + + + - + +

+ - - + + + - - + + + + - + +

TIFFTAG_IMAGEWIDTH

+ + + - - + + + - - + - + +

†

- - + - + + - - +

+ - - + + + - - + + + + - +

TIFFTAG_INKSET

+ + + - - + + + - - + - +

†

- - + - - + + - +

+ - - + + + - - + - +

† JPEG pseudo-tag

- - + - - + + - +

+ - - + + + - + - - +

JPEG pseudo-tag

- - + - - + + - +

+ - - + + + - - + - +

† count & tables

- - + - - + + - +

+ - - + + + - - + - +

† JPEG pseudo-tag

- - + + + - - + + + + + + - +

char*

+ - - + - + + - - +

+ - - + + + - - + - + +

†

- - + - - + + - +

+ - - + + + - + + + + + + + + + + + + - - +

uint16

+ - - + - - + + - +

+ - - + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + +

+ - - + + + - + - - +

†

- - + - - + + - +

+ - - + + + - - + - +

†

- - + - - + + - +

+ - - + + + - + - - +

6-entry array

- - + - - + + - +

+ - - + + + - - + - +

† 6-entry array

- - + + + - + + + + + + - - +

uint16

+ - - + - + + - - +

+ - - + + + - - + - +

count, data

- - + - - + + - +

+ - - + + + - - + - +

† must be > 0

- - + - + + - - +

+ - - + + + + - + + + + + + + + + + + + + + + - - +

TIFFTAG_SMAXSAMPLEVALUE

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+		+ - TIFFTAG_ARTIST -	+ Tag Name		- 1 -	- char* -	-	+
+				- TIFFTAG_BADFAXLINES -	- 1 -	+ Types	- uint32 -	-
+		- TIFFTAG_BITSPERSAMPLE -	- 1 -	+ TIFFTAG_ARTIST		- uint16 -	- † -	+
+				+ + + char*	+
+ - TIFFTAG_CLEANFAXDATA -	+ TIFFTAG_BADFAXLINES		- 1 -	- uint16 -	-	+
+				- TIFFTAG_COLORMAP -	- 3 -	+ uint32	+
+ + + TIFFTAG_BITSPERSAMPLE		- uint16* -	- 1<<BitsPerSample arrays -	+
+				- TIFFTAG_COMPRESSION -	- 1 -	+ uint16	- uint16 -	- † -
+		+ + + TIFFTAG_CLEANFAXDATA		+ - TIFFTAG_CONSECUTIVEBADFAXLINES -	+ 1	+
		- 1 -	- uint32 -	-	+
+		+ - TIFFTAG_COPYRIGHT -	+ TIFFTAG_COLORMAP		- 1 -	- char* -	-	+
+				+ - TIFFTAG_DATETIME -	+ uint16*	- 1 -	- char* -	-
+		- TIFFTAG_DOCUMENTNAME -	- 1 -	+ TIFFTAG_COMPRESSION		- char* -	-	+
+				+ - TIFFTAG_DOTRANGE -	+ uint16	- 2 -	- uint16 -	-
+		- TIFFTAG_EXTRASAMPLES -	- 2 -	+ TIFFTAG_CONSECUTIVEBADFAXLINES		- uint16,uint16* -	- † count & types array -	+
+				- TIFFTAG_FAXFILLFUNC -	- 1 -	+ uint32	+
- TIFFFaxFillFunc -	- G3/G4 compression pseudo-tag -		+ + + 1	+
		+ + + char*	+
+		- TIFFTAG_FAXMODE -	- 1 -	+ TIFFTAG_DATETIME		- int -	- † G3/G4 compression pseudo-tag -	+
+				- TIFFTAG_FILLORDER -	- 1 -	+ char*	+
+ + + TIFFTAG_DOCUMENTNAME		+ + + 1	+
		- uint16 -	- † -	+
+		- TIFFTAG_GROUP3OPTIONS -	- 1 -	+ TIFFTAG_DOTRANGE		- uint32 -	- † -	+
+				- TIFFTAG_GROUP4OPTIONS -	- 1 -	+ uint16	+
+ + + TIFFTAG_EXTRASAMPLES		- uint32 -	- † -	+
+				- TIFFTAG_HALFTONEHINTS -	- 2 -	+ uint16,uint16*	- uint16 -	-
+		+ - TIFFTAG_HOSTCOMPUTER -	+ TIFFTAG_FAXFILLFUNC		- 1 -	- char* -	-	+
+				- TIFFTAG_ICCPROFILE -	- 2 -	+ TIFFFaxFillFunc	- uint32,void* -	- count, profile data -
+		- TIFFTAG_IMAGEDEPTH -	- 1 -	+ TIFFTAG_FAXMODE		- uint32 -	- † -	+
+				+ - TIFFTAG_IMAGEDESCRIPTION -	+ int	- 1 -	- char* -	-
+		- TIFFTAG_IMAGELENGTH -	- 1 -	+ TIFFTAG_FILLORDER		- uint32 -	-	+
+				- TIFFTAG_IMAGEWIDTH -	- 1 -	+ uint16	- uint32 -	- † -
+		+ - TIFFTAG_INKNAMES -	+ TIFFTAG_GROUP3OPTIONS		- 2 -	- uint16, char* -	-	+
+				- TIFFTAG_INKSET -	- 1 -	+ uint32	- uint16 -	- † -
+		- TIFFTAG_JPEGCOLORMODE -	- 1 -	+ TIFFTAG_GROUP4OPTIONS		- int -	- † JPEG pseudo-tag -	+
+				- TIFFTAG_JPEGQUALITY -	- 1 -	+ uint32	- int -	- JPEG pseudo-tag -
+		+ - TIFFTAG_JPEGTABLES -	+ TIFFTAG_HALFTONEHINTS		- 2 -	- uint32,void -	+ 2	+
		+ - † count & tables -	+
+		- TIFFTAG_JPEGTABLESMODE -	- 1 -	+ TIFFTAG_HOSTCOMPUTER		- int -	- † JPEG pseudo-tag -	+
+				- TIFFTAG_MAKE -	- 1 -	+ char*	+
- char* -	-		+ + + 2	+
+				- TIFFTAG_MATTEING -	- 1 -	+ uint32,void*	- uint16 -	- † -
+		- TIFFTAG_MAXSAMPLEVALUE -	- 1 -	+ TIFFTAG_IMAGEDEPTH		- uint16 -	-	+
+				+ - TIFFTAG_MINSAMPLEVALUE -	+ uint32	- 1 -	- uint16 -	-
+		+ - TIFFTAG_MODEL -	+ TIFFTAG_IMAGEDESCRIPTION		- 1 -	- char* -	-	+
+				- TIFFTAG_ORIENTATION -	- 1 -	+ char*	+
+ + + TIFFTAG_IMAGELENGTH		- uint16 -	-	+
+				- TIFFTAG_PAGENAME -	- 1 -	+ uint32	+
- char* -	-		+ + + 1	+
+				- TIFFTAG_PAGENUMBER -	- 2 -	+ uint32	- uint16 -	-
+		+ - TIFFTAG_PHOTOMETRIC -	+ TIFFTAG_INKNAMES		- 1 -	- uint16 -	-	+
+				- TIFFTAG_PHOTOSHOP -	- ? -	+ uint16, char*	+
- uint32,void* -	- count, data -		+ + + 1	+
+				- TIFFTAG_PLANARCONFIG -	- 1 -	+ uint16	- uint16 -	- † -
+		- TIFFTAG_PREDICTOR -	- 1 -	+ TIFFTAG_JPEGCOLORMODE		- uint16 -	- † -	+
+				- TIFFTAG_PRIMARYCHROMATICITIES -	- 1 -	+ int	- float* -	- 6-entry array -
+		- TIFFTAG_REFERENCEBLACKWHITE -	- 1 -	+ TIFFTAG_JPEGQUALITY		- float* -	- † 2*SamplesPerPixel array -	+
+				+ - TIFFTAG_RESOLUTIONUNIT -	+ int	- 1 -	- uint16 -	-
+		- TIFFTAG_RICHTIFFIPTC -	- 2 -	+ TIFFTAG_JPEGTABLES		- uint32,void* -	- count, data -	+
+				- TIFFTAG_ROWSPERSTRIP -	- 1 -	+ uint32,void	- uint32 -	- † must be > 0 -
+		- TIFFTAG_SAMPLEFORMAT -	- 1 -	+ TIFFTAG_JPEGTABLESMODE		- uint16 -	- † -	+
+				- TIFFTAG_SAMPLESPERPIXEL -	- 1 -	+ int	- uint16 -	- † value must be <= 4 -
+		+ + + TIFFTAG_MAKE		- TIFFTAG_SMAXSAMPLEVALUE -	- 1 -	+ 1	+
		+ - double -	-	+
+		+ - TIFFTAG_SMINSAMPLEVALUE -	+ TIFFTAG_MATTEING		- 1 -	- double -	-	+
+				- TIFFTAG_SOFTWARE -	- 1 -	+ uint16	- char* -	-
+		- TIFFTAG_STONITS -	- 1 -	+ TIFFTAG_MAXSAMPLEVALUE		- double -	- † -	+
+				+ - TIFFTAG_SUBFILETYPE -	+ uint16	+
+ + + TIFFTAG_MINSAMPLEVALUE		+ + + 1	+
		- 1 -	- uint32 -	-	+
+		- TIFFTAG_SUBIFD -	- 2 -	+ TIFFTAG_MODEL		- uint16,uint32* -	- count & offsets array -	+
+				- TIFFTAG_TARGETPRINTER -	- 1 -	+ char*	+
+ + + TIFFTAG_ORIENTATION		+ + + 1	+
		+ + + uint16	+
+ + + TIFFTAG_PAGENAME		+ + + 1	+
		+ + + char*	+
+ + + TIFFTAG_PAGENUMBER		+ + + 2	+
		+ + + uint16	+
+ + + TIFFTAG_PHOTOMETRIC		+ + + 1	+
		+ + + uint16	+
+ + + TIFFTAG_PHOTOSHOP		+ + + ?	+
		+ + + uint32,void*	+ + + count, data
+ + + TIFFTAG_PLANARCONFIG		- char* -	-	+
+				+ - TIFFTAG_THRESHHOLDING -	+ uint16	- 1 -	- uint16 -	-
+		- TIFFTAG_TILEDEPTH -	- 1 -	+ TIFFTAG_PREDICTOR		- uint32 -	- † -	+
+				- TIFFTAG_TILELENGTH -	- 1 -	+ uint16	- uint32 -	- † must be a multiple of 8 -
+		- TIFFTAG_TILEWIDTH -	- 1 -	+ TIFFTAG_PRIMARYCHROMATICITIES		- uint32 -	- † must be a multiple of 8 -	+
+				+ - TIFFTAG_TRANSFERFUNCTION -	+ float*	- 1 or 3‡ uint16* -		- 1<<BitsPerSample entry arrays -
+		- TIFFTAG_WHITEPOINT -	- 1 -	+ TIFFTAG_REFERENCEBLACKWHITE		- float* -	- 2-entry array -	+
+				- TIFFTAG_XMLPACKET -	- 2 -	+ float*	- uint32,void* -	- count, data -
+		+ + + TIFFTAG_RESOLUTIONUNIT		+ - TIFFTAG_XPOSITION -	+ 1	+
		- 1 -	- float -	-	+
+		+ - TIFFTAG_XRESOLUTION -	+ TIFFTAG_RICHTIFFIPTC		- 1 -	- float -	-	+
+				- TIFFTAG_YCBCRCOEFFICIENTS -	- 1 -	+ uint32,void*	- float* -	- † 3-entry array -
+		- TIFFTAG_YCBCRPOSITIONING -	- 1 -	+ TIFFTAG_ROWSPERSTRIP		- uint16 -	- † -	+
+				- TIFFTAG_YCBCRSAMPLING -	- 2 -	+ uint32	- uint16 -	- † -
+		+ - TIFFTAG_YPOSITION -	+ TIFFTAG_SAMPLEFORMAT		- 1 -	- float -	-	+
+				+ + + uint16	+ - TIFFTAG_YRESOLUTION -	+ †
+ + + TIFFTAG_SAMPLESPERPIXEL		+ + + 1	+
		+ + + uint16	+ + + † value must be <= 4
- 1 -	- float -	-		+ + + 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_WHITEPOINT		+ + + 1	+
		+ + + float*	+ + + 2-entry array
+ + + TIFFTAG_XMLPACKET		+ + + 2	+
		+ + + uint32,void*	+ + + count, data
+ + + TIFFTAG_XPOSITION		+ + + 1	+
		+ + + float	+
+ + + TIFFTAG_XRESOLUTION		+ + + 1	+
		+ + + float	+
+ + + TIFFTAG_YCBCRCOEFFICIENTS		+ + + 1	+
		+ + + float*	+ + + † 3-entry array
+ + + TIFFTAG_YCBCRPOSITIONING		+ + + 1	+
		+ + + uint16	+ + + †
+ + + TIFFTAG_YCBCRSAMPLING		+ + + 2	+
		+ + + uint16	+ + + †
+ + + TIFFTAG_YPOSITION		+ + + 1	+
		+ + + float	+
+ + + TIFFTAG_YRESOLUTION		+ + + 1	+
		+ + + float	+

- - - - - -

† Tag may not have its values changed once data is -written.
+ +

† Tag may not have its +values changed once data is written.
‡ If SamplesPerPixel is one, then a single -array is passed; otherwise three arrays should be -passed.
+array is passed; otherwise three arrays should be passed. +
* 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 http://www.color.org) for an explanation.

+ +

RETURN VALUES -

RETURN VALUES

- - - - - -

1 is returned if the operation was successful. Otherwise, -0 is returned if an error was detected.

+ + + +

1 is returned +if the operation was successful. Otherwise, 0 is returned if +an error was detected.

+ +

DIAGNOSTICS -

DIAGNOSTICS

- - - - - -

All error messages are directed to the -TIFFError(3TIFF) routine.

- -

%s: Cannot modify tag "%s" while -writing. 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.

- -

%d: Bad value for "%s". An invalid value -was supplied for the named tag.

+ + + +

All error +messages are directed to the TIFFError(3TIFF) +routine.

+ +

%s: Cannot +modify tag "%s" while writing. 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.

+ +

%d: Bad +value for "%s". An invalid value was supplied +for the named tag.

+ +

TIFFSetField

TIFFSetField

NAME -

NAME

SYNOPSIS -

SYNOPSIS

DESCRIPTION -

DESCRIPTION

RETURN VALUES -

RETURN VALUES

DIAGNOSTICS -

DIAGNOSTICS

SEE ALSO -

SEE ALSO