File: streamtuner-st-sgml-ref-api.html

package info (click to toggle)
streamtuner 0.99.99-15
  • links: PTS
  • area: main
  • in suites: lenny, squeeze
  • size: 5,220 kB
  • ctags: 2,980
  • sloc: ansic: 27,119; sh: 8,206; xml: 4,811; makefile: 444; python: 366
file content (60 lines) | stat: -rw-r--r-- 5,492 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>st-sgml-ref</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="streamtuner Developers Manual"><link rel="up" href="api-reference.html" title="API Reference"><link rel="prev" href="streamtuner-st-settings-api.html" title="st-settings"><link rel="next" href="streamtuner-st-state-api.html" title="st-state"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
        .synopsis, .classsynopsis {
            background: #eeeeee;
            border: solid 1px #aaaaaa;
            padding: 0.5em;
        }
        .programlisting {
            background: #feffde;
            border: solid 1px #e9ed1c;
            padding: 0.5em;
        }
        .variablelist {
            padding: 4px;
            margin-left: 3em;
        }
        .navigation {
            background: #daffd1;
            border: solid 1px #74ff54;
            margin-top: 0.5em;
            margin-bottom: 0.5em;
        }
        .navigation a {
            color: #2fba0f;
        }
        .navigation a:visited {
            color: #22850b;
        }
        .navigation .title {
            font-size: 200%;
        }
      </style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="streamtuner-st-settings-api.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="api-reference.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">streamtuner Developers Manual</th><td><a accesskey="n" href="streamtuner-st-state-api.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="streamtuner-st-sgml-ref-api"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">st-sgml-ref</span></h2><p>st-sgml-ref &#8212; functions for expanding SGML character references.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">



char*       <a href="streamtuner-st-sgml-ref-api.html#st-sgml-ref-expand">st_sgml_ref_expand</a>              (const char *str);
char*       <a href="streamtuner-st-sgml-ref-api.html#st-sgml-ref-expand-len">st_sgml_ref_expand_len</a>          (const char *str,
                                             int len);
</pre></div><div class="refsect1" lang="en"><a name="id2629850"></a><h2>Description</h2><p>

</p></div><div class="refsect1" lang="en"><a name="id2629860"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2629865"></a><h3><a name="st-sgml-ref-expand"></a>st_sgml_ref_expand ()</h3><a class="indexterm" name="id2629874"></a><pre class="programlisting">char*       st_sgml_ref_expand              (const char *str);</pre><p>
Parses <i class="parameter"><tt>str</tt></i>, expanding its SGML character references and XHTML
character entities. See <a href="streamtuner-st-sgml-ref-api.html#st-sgml-ref-expand-len"><tt class="function">st_sgml_ref_expand_len()</tt></a>.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i>:</span></td><td> the nul-terminated string to parse.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the expansion of <i class="parameter"><tt>str</tt></i>. The string should be freed
when no longer needed.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2630018"></a><h3><a name="st-sgml-ref-expand-len"></a>st_sgml_ref_expand_len ()</h3><a class="indexterm" name="id2630026"></a><pre class="programlisting">char*       st_sgml_ref_expand_len          (const char *str,
                                             int len);</pre><p>
Parses <i class="parameter"><tt>str</tt></i>, expanding its SGML character references and XHTML
character entities.
</p><p>
Numerical SGML character references as well as XHTML entities are
supported. Unsupported entities will be inserted verbatim into the
result.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i>:</span></td><td> the string to parse.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i>:</span></td><td> the length of <i class="parameter"><tt>str</tt></i>, or -1 if <i class="parameter"><tt>str</tt></i> is nul-terminated.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the expansion of <i class="parameter"><tt>str</tt></i>. The string should be freed
when no longer needed.
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="streamtuner-st-settings-api.html"><b>&lt;&lt;st-settings</b></a></td><td align="right"><a accesskey="n" href="streamtuner-st-state-api.html"><b>st-state&gt;&gt;</b></a></td></tr></table></body></html>