File: st-programs-api.xml

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 (95 lines) | stat: -rw-r--r-- 3,270 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<refentry id="streamtuner-st-programs-api">
<refmeta>
<refentrytitle>st-programs</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>st-programs</refname><refpurpose>functions for defining and executing programs (deprecated).</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



<link linkend="void">void</link>        <link linkend="st-programs-register">st_programs_register</link>            (const <link linkend="char">char</link> *action,
                                             const <link linkend="char">char</link> *command);
<link linkend="gboolean">gboolean</link>    <link linkend="st-programs-run">st_programs_run</link>                 (const <link linkend="char">char</link> *action,
                                             const <link linkend="char">char</link> *locator,
                                             <link linkend="GError">GError</link> **err);
</synopsis>
</refsynopsisdiv>









<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="st-programs-register"/>st_programs_register ()</title>
<indexterm><primary>st_programs_register</primary></indexterm><programlisting><link linkend="void">void</link>        st_programs_register            (const <link linkend="char">char</link> *action,
                                             const <link linkend="char">char</link> *command);</programlisting>
<warning><para><literal>st_programs_register</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>command</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-programs-run"/>st_programs_run ()</title>
<indexterm><primary>st_programs_run</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    st_programs_run                 (const <link linkend="char">char</link> *action,
                                             const <link linkend="char">char</link> *locator,
                                             <link linkend="GError">GError</link> **err);</programlisting>
<warning><para><literal>st_programs_run</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>locator</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
<link linkend="streamtuner-st-action-api">st-action</link>
</para>
</refsect1>

</refentry>