← Back to branch summary

~beaky/wacs/wacs-php

« back to all changes in this revision

Viewing changes to docs/programming/htmlm/re17.html

  • Committer: beaky
  • Date: 2020-06-29 15:31:34 UTC
  • Revision ID: svn-v4:4196e993-711f-0410-950c-c89e1d26c723:wacs-php:2901
Documentation build complete for wacs-php 1.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/programming/htmlm/re17.html
1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>getvaluename</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Wacs Programming Guide"><link rel="up" href="ch08s02.html" title="Core Module: Reference"><link rel="prev" href="re16.html" title="loadattrvalues"><link rel="next" href="re18.html" title="geticonlist"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">getvaluename</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re16.html">Prev</a>�</td><th width="60%" align="center">Core Module: Reference</th><td width="20%" align="right">�<a accesskey="n" href="re18.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="api-core-getvaluename"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>getvaluename &#8212; provide the long name for the specified value of specified type
2
 
</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">use Wacs;</pre><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">scalar <b class="fsfunc">getvaluename</b>(</code></td><td>...<code>)</code>;</td><td>�</td></tr></table><div class="funcprototype-spacer">�</div></div></div><div class="refsect1"><a name="idm46217811353200"></a><h2>Parameters</h2><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>parameter</th><th>description</th></tr></thead><tbody><tr><td>object</td><td>The object you want the mapping for - see geticonlist below</td></tr><tr><td>value</td><td>The value you want mapped to it's long format (often a single
3
 
character.</td></tr></tbody></table></div></div><div class="refsect1"><a name="idm46217811346032"></a><h2>Summary</h2><p>The <code class="function">getvaluename</code> function returns the long
 
2
</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">use Wacs;</pre><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">scalar <b class="fsfunc">getvaluename</b>(</code></td><td>...<code>)</code>;</td><td>�</td></tr></table><div class="funcprototype-spacer">�</div></div></div><div class="refsect1"><a name="idm46564163890512"></a><h2>Parameters</h2><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>parameter</th><th>description</th></tr></thead><tbody><tr><td>object</td><td>The object you want the mapping for - see geticonlist below</td></tr><tr><td>value</td><td>The value you want mapped to it's long format (often a single
 
3
character.</td></tr></tbody></table></div></div><div class="refsect1"><a name="idm46564163883344"></a><h2>Summary</h2><p>The <code class="function">getvaluename</code> function returns the long
4
4
(readable) name for the specified short value of specified fixed values
5
5
attribute type.
6
6
For instance, if you want to get the long name for type "M", you
7
7
call <code class="function">getvaluename</code> with <code class="literal">object=&gt;"types"
8
8
</code> and <code class="literal">value=&gt;M</code> and <code class="function">getvaluename
9
9
</code> will return <code class="literal">Masturbation</code>.
10
 
</p></div><div class="refsect1"><a name="idm46217811340928"></a><h2>Availability</h2><p><code class="function">getvaluename</code> is available in both perl and php.
 
10
</p></div><div class="refsect1"><a name="idm46564163878240"></a><h2>Availability</h2><p><code class="function">getvaluename</code> is available in both perl and php.
11
11
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re16.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="ch08s02.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="re18.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">loadattrvalues�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�geticonlist</td></tr></table></div></body></html>