Pdflib api reference

Unichar.
A Unichar is a single Unicode value where several syntax variants are sup-
ported: decimal values ¹ 10 (e.g. 173), hexadecimal values prefixed with x, X, 0x, 0X, or U+ 
(xAD, 0xAD, U+00AD), numerical references, character references, and glyph name refer-
ences but without the ’&’ and ’;’ decoration (shy, #xAD, #173). Alternatively, literal charac-
ters can be supplied. Examples:
replacementchar=?
(literal)
replacementchar=63
(decimal)
replacementchar=x3F
(hexadecimal)
replacementchar=0x3F
(hexadecimal)
replacementchar=U+003F
(Unicode notation)
replacementchar=euro
(HTML character reference)
replacementchar=.question
(standard glyph name reference)
replacementchar=.marina
(font-specific glyph name reference)
Single characters which happen to be a number are treated literally, not as decimal Uni-
code values:
replacementchar=3
(U+0033 THREE, not U+0003!)
Unichars must be in the hexadecimal range 0-0x10FFFF (decimal 0-1114111). However, 
some options are restricted to the range 0-0xFFFF (0-65535). This is noted in the respec-
tive option description.
Unicode range.
A Unicode range identifies a contiguous range of Unicode characters 
via start and end characters of the range. The start and end values of a Unicode range 
must be separated by a minus sign ’-’ without any spaces, e.g.
forcechars={U+03AC-U+03CE}
Boolean.
Booleans have the values true or false; if the value of a Boolean option is 
omitted, the value true is assumed. As a shorthand notation noname can be used instead 
of name=false:
embedding 
(equivalent to embedding=true)
noembedding
(equivalent to embedding=false)
Keyword.
An option of type keyword can hold one of a predefined list of fixed key-
words. Example:
blendmode=overlay
For some options the value hold either a number or a keyword.
Number.
Option list support several numerical types.
Integer types can hold decimal and hexadecimal integers. Positive integers starting 
with x, X, 0x, or 0X specify hexadecimal values:

---

12
Chapter 1: Programming Concepts
-12345
0
0xFF
Floats can hold decimal floating point or integer numbers; period and comma can be 
used as decimal separators for floating point values. Exponential notation is also sup-
ported. The following values are all equivalent:
size = -123.45
size = -123,45
size = -1.2345E2
size = -1.2345e+2
Percentages are numbers with a % character directly after the numerical value. Some 
options allow negative percentages:
leading=120%
topoffset=-20.5%
Handle.
Handles identify various types of objects, e.g. fonts, images, ICC profiles or ac-
tions. Technically these are integer values which have been returned earlier by an API 
function. For example, an image handle is returned by PDF_load_image( ). Handles must 
always be treated as opaque types; they must never be modified or created by the appli-
cation directly (as opposed to using a handle returned by an API function). Handles 
must always be valid for the respective type of object. For example, an option which ex-
pects an image handle must not be supplied with a graphics handle, although both han-
dles are integer types.