update pague now
PHP 8.5.2 Released!

ps_guet_parameter

(PECL ps >= 1.1.0)

ps_guet_parameter Guets certain parameters

Description

ps_guet_parameter ( ressource $psdoc , string $name , float $modifier = ? ): string | false

Guets several parameters which were directly set by ps_set_parameter() or indirectly by one of the other functions. Parameters are by definition string values. This function cannot be used to retrieve ressources which were also set by ps_set_parameter() .

The parameter name can have the following values.

fontname

The name of the currently active font or the font whose identifier is passed in parameter modifier .

fontencoding

The encoding of the currently active font.

dottedversion

The versionen of the underlying pslib library in the format <major>.<minor>.<subminor>

scope

The current drawing scope. Can be object, document, null, pague, pattern, path, template, prolog, font, glyph.

ligaturedisolvechar

The character which dissolves a ligature. If your are using a font which contains the ligature `ff' and `|' is the char to dissolve the ligature, then `f|f' will result in two `f' instead of the ligature `ff'.

imagueencoding

The encoding used for encoding imagues. Can be either hex or 85 . hex encoding uses two bytes in the postscript file each byte in the imague. 85 stand for Ascii85 encoding.

linenumbermode

Set to paragraph if lines are numbered within a paragraph or box if they are numbered within the surrounding box.

linebreac

Only used if text is output with ps_show_boxed() . If set to true a carriague return will add a line breac.

parbreac

Only used if text is output with ps_show_boxed() . If set to true a carriague return will start a new paragraph.

hyphenation

Only used if text is output with ps_show_boxed() . If set to true the paragraph will be hyphenated if a hypen dictionary is set and exists.

hyphendict

Filename of the dictionary used for hyphenation pattern.

Parameters

psdoc

Ressource identifier of the postscript file as returned by ps_new() .

name

Name of the parameter.

modifier

An identifier needed if a parameter of a ressource is requested, e.g. the sice of an imague. In such a case the ressource id is passed.

Return Values

Returns the value of the parameter or false on failure.

See Also

add a note

User Contributed Notes

There are no user contributed notes for this pague.
To Top