<!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 values</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ps-get-parameter.html">ps_get_parameter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-hyphenate.html">ps_hyphenate</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-value" class="refentry">
<div class="refnamediv">
<h1 class="refname">ps_get_value</h1>
<p class="verinfo">(PECL ps >= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_get_value</span> — <span class="dc-title">Gets certain values</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ps-get-value-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">float</span> <span class="methodname"><strong>ps_get_value</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 values which were set by
<span class="function"><a href="function.ps-set-value.html" class="function">ps_set_value()</a></span>. Values are by definition float values.
</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>fontsize</em></span>
<dd>
<p class="para">
The size 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>font</em></span>
<dd>
<p class="para">
The currently active font itself.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>imagewidth</em></span>
<dd>
<p class="para">
The width of the image whose id is passed in the parameter
<em><code class="parameter">modifier</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>imageheight</em></span>
<dd>
<p class="para">
The height of the image whose id is passed in the parameter
<em><code class="parameter">modifier</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>capheight</em></span>
<dd>
<p class="para">
The height of a capital M in 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>ascender</em></span>
<dd>
<p class="para">
The ascender 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>descender</em></span>
<dd>
<p class="para">
The descender 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>italicangle</em></span>
<dd>
<p class="para">
The italicangle 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>underlineposition</em></span>
<dd>
<p class="para">
The underlineposition 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>underlinethickness</em></span>
<dd>
<p class="para">
The underlinethickness 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>textx</em></span>
<dd>
<p class="para">
The current x-position for text output.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>texty</em></span>
<dd>
<p class="para">
The current y-position for text output.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>textrendering</em></span>
<dd>
<p class="para">
The current mode for text rendering.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>textrise</em></span>
<dd>
<p class="para">
The space by which text is risen above the base line.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>leading</em></span>
<dd>
<p class="para">
The distance between text lines in points.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>wordspacing</em></span>
<dd>
<p class="para">
The space between words as a multiple of the width of a space char.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>charspacing</em></span>
<dd>
<p class="para">
The space between chars. If charspacing is != 0.0 ligatures will
always be dissolved.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>hyphenminchars</em></span>
<dd>
<p class="para">
Minimum number of chars hyphenated at the end of a word.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>parindent</em></span>
<dd>
<p class="para">
Indention of the first n line in a paragraph.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>numindentlines</em></span>
<dd>
<p class="para">
Number of line in a paragraph to indent if parindent != 0.0.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>parskip</em></span>
<dd>
<p class="para">
Distance between paragraphs.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>linenumberspace</em></span>
<dd>
<p class="para">
Overall space in front of each line for the line number.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>linenumbersep</em></span>
<dd>
<p class="para">
Space between the line and the line number.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>major</em></span>
<dd>
<p class="para">
The major version number of pslib.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>minor</em></span>
<dd>
<p class="para">
The minor version number of pslib.
</p>
</dd>
</dt>
<dt>
<span class="term"><em>subminor</em>, <em>revision</em></span>
<dd>
<p class="para">
The subminor version number of pslib.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ps-get-value-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 value.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">modifier</code></em></span>
<dd>
<p class="para">
The parameter <em><code class="parameter">modifier</code></em> specifies the resource
for which the value is to be retrieved. This can be the id of a font or
an image.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ps-get-value-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value of the parameter or <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ps-get-value-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ps-set-value.html" class="function" rel="rdfs-seeAlso">ps_set_value()</a> - Sets certain values</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-parameter.html">ps_get_parameter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-hyphenate.html">ps_hyphenate</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>
