<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets certain parameters</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ps-get-buffer.html">ps_get_buffer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-get-value.html">ps_get_value</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ps-get-parameter" class="refentry">
<div class="refnamediv">
<h1 class="refname">ps_get_parameter</h1>
<p class="verinfo">(PECL ps >= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_get_parameter</span> — <span class="dc-title">Gets certain parameters</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ps-get-parameter-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>ps_get_parameter</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$psdoc</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type">float</span> <code class="parameter">$modifier</code></span>
] )</div>
<p class="para rdfs-comment">
Gets several parameters which were directly set by
<span class="function"><a href="function.ps-set-parameter.html" class="function">ps_set_parameter()</a></span> or indirectly by one of the other
functions. Parameters are by definition string
values. This function cannot be used to retrieve resources which were also
set by <span class="function"><a href="function.ps-set-parameter.html" class="function">ps_set_parameter()</a></span>.
</p>
<p class="para">
The parameter <em><code class="parameter">name</code></em> can have the following values.
</p>
<p class="para">
<dl>
<dt>
<span class="term"><em>fontname</em></span>
<dd>
<p class="para">
The name of the currently active font or the font whose
identifier is passed in parameter <em><code class="parameter">modifier</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>fontencoding</em></span>
<dd>
<p class="para">
The encoding of the currently active font.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>dottedversion</em></span>
<dd>
<p class="para">
The version of the underlying pslib library in the format
<major>.<minor>.<subminor>
</p>
</dd>
</dt>
<dt>
<span class="term"><em>scope</em></span>
<dd>
<p class="para">
The current drawing scope. Can be object, document, null, page,
pattern, path, template, prolog, font, glyph.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>ligaturedisolvechar</em></span>
<dd>
<p class="para">
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'.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>imageencoding</em></span>
<dd>
<p class="para">
The encoding used for encoding images. Can be either
<em>hex</em> or <em>85</em>. hex encoding
uses two bytes in the postscript file each byte in the image.
85 stand for Ascii85 encoding.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>linenumbermode</em></span>
<dd>
<p class="para">
Set to <em>paragraph</em> if lines are numbered
within a paragraph or <em>box</em> if they are
numbered within the surrounding box.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>linebreak</em></span>
<dd>
<p class="para">
Only used if text is output with <span class="function"><a href="function.ps-show-boxed.html" class="function">ps_show_boxed()</a></span>.
If set to <strong><code>TRUE</code></strong> a carriage return will add a line
break.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>parbreak</em></span>
<dd>
<p class="para">
Only used if text is output with <span class="function"><a href="function.ps-show-boxed.html" class="function">ps_show_boxed()</a></span>.
If set to <strong><code>TRUE</code></strong> a carriage return will start
a new paragraph.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>hyphenation</em></span>
<dd>
<p class="para">
Only used if text is output with <span class="function"><a href="function.ps-show-boxed.html" class="function">ps_show_boxed()</a></span>.
If set to <strong><code>TRUE</code></strong> the paragraph will be hyphenated
if a hypen dictionary is set and exists.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>hyphendict</em></span>
<dd>
<p class="para">
Filename of the dictionary used for hyphenation pattern.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ps-get-parameter-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">psdoc</code></em></span>
<dd>
<p class="para">
Resource identifier of the postscript file
as returned by <span class="function"><a href="function.ps-new.html" class="function">ps_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">name</code></em></span>
<dd>
<p class="para">
Name of the parameter.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">modifier</code></em></span>
<dd>
<p class="para">
An identifier needed if a parameter of a resource is requested,
e.g. the size of an image. In such a case the resource id is
passed.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ps-get-parameter-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value of the parameter or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ps-get-parameter-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ps-set-parameter.html" class="function" rel="rdfs-seeAlso">ps_set_parameter()</a> - Sets certain parameters</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ps-get-buffer.html">ps_get_buffer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-get-value.html">ps_get_value</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
