gupnp-service-introspection.xml

另一 UPNP SDK 支持在UNIX/LINUX上运行。 UPnP是一种网络协议

<para>

</para><variablelist role="struct">
<varlistentry>
<term><link linkend="char">char</link>&nbsp;*<structfield>name</structfield>;</term>
<listitem><simpara> The name of the state variable.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gboolean">gboolean</link>&nbsp;<structfield>send_events</structfield>;</term>
<listitem><simpara> Whether this state variable can source events.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gboolean">gboolean</link>&nbsp;<structfield>is_numeric</structfield>;</term>
<listitem><simpara> Wether this state variable is a numeric type (integer and
float).
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GType">GType</link>&nbsp;<structfield>type</structfield>;</term>
<listitem><simpara> The GType of this state variable.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GValue">GValue</link>&nbsp;<structfield>default_value</structfield>;</term>
<listitem><simpara> The default value of this state variable.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GValue">GValue</link>&nbsp;<structfield>minimum</structfield>;</term>
<listitem><simpara> The minimum value of this state variable. Only applies to numeric
data types.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GValue">GValue</link>&nbsp;<structfield>maximum</structfield>;</term>
<listitem><simpara> The maximum value of this state variable. Only applies to numeric
data types.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GValue">GValue</link>&nbsp;<structfield>step</structfield>;</term>
<listitem><simpara> The step value of this state variable. Only applies to numeric
data types.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GList">GList</link>&nbsp;*<structfield>allowed_values</structfield>;</term>
<listitem><simpara> The allowed values of this state variable. Only applies to
string data types. Unlike the other fields in this structure, this field
contains a list of (char *) strings rather than GValues.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GUPnPServiceIntrospection-struct" role="struct">
<title>GUPnPServiceIntrospection</title>
<indexterm zone="GUPnPServiceIntrospection-struct"><primary>GUPnPServiceIntrospection</primary></indexterm><programlisting>typedef struct _GUPnPServiceIntrospection GUPnPServiceIntrospection;</programlisting>
<para>
This struct contains private data only, and should be accessed using the
functions below.</para>
<para>

</para></refsect2>
<refsect2 id="gupnp-service-introspection-list-action-names" role="function">
<title>gupnp_service_introspection_list_action_names ()</title>
<indexterm zone="gupnp-service-introspection-list-action-names"><primary>gupnp_service_introspection_list_action_names</primary></indexterm><programlisting>const <link linkend="GList">GList</link>*        gupnp_service_introspection_list_action_names
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);</programlisting>
<para>
Returns a GList of names of all the actions in this service.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>introspection</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A GList of names of all the actions or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. Do not modify
or free it or its contents.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-introspection-list-actions" role="function">
<title>gupnp_service_introspection_list_actions ()</title>
<indexterm zone="gupnp-service-introspection-list-actions"><primary>gupnp_service_introspection_list_actions</primary></indexterm><programlisting>const <link linkend="GList">GList</link>*        gupnp_service_introspection_list_actions
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);</programlisting>
<para>
Returns a <link linkend="GList"><type>GList</type></link> of all the actions (of type <link linkend="GUPnPServiceActionInfo"><type>GUPnPServiceActionInfo</type></link>) in
this service.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>introspection</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of all the actions or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. Do not modify or free it
or its contents.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-introspection-get-action" role="function">
<title>gupnp_service_introspection_get_action ()</title>
<indexterm zone="gupnp-service-introspection-get-action"><primary>gupnp_service_introspection_get_action</primary></indexterm><programlisting>const <link linkend="GUPnPServiceActionInfo">GUPnPServiceActionInfo</link>* gupnp_service_introspection_get_action
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
                                                         const <link linkend="gchar">gchar</link> *action_name);</programlisting>
<para>
Returns the action by the name <parameter>action_name</parameter> in this service.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>introspection</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>action_name</parameter>&nbsp;:</term>
<listitem><simpara> The name of the action to retreive
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the action or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. Do not modify or free it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-introspection-list-state-variable-names" role="function">
<title>gupnp_service_introspection_list_state_variable_names ()</title>
<indexterm zone="gupnp-service-introspection-list-state-variable-names"><primary>gupnp_service_introspection_list_state_variable_names</primary></indexterm><programlisting>const <link linkend="GList">GList</link>*        gupnp_service_introspection_list_state_variable_names
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);</programlisting>
<para>
Returns a <link linkend="GList"><type>GList</type></link> of names of all the state variables in this service.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>introspection</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of names of all the state variables or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. Do not
modify or free it or its contents.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-introspection-list-state-variables" role="function">
<title>gupnp_service_introspection_list_state_variables ()</title>
<indexterm zone="gupnp-service-introspection-list-state-variables"><primary>gupnp_service_introspection_list_state_variables</primary></indexterm><programlisting>const <link linkend="GList">GList</link>*        gupnp_service_introspection_list_state_variables
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection);</programlisting>
<para>
Returns a GList of all the state variables (of type
<link linkend="GUPnPServiceStateVariableInfo"><type>GUPnPServiceStateVariableInfo</type></link>) in this service.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>introspection</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of all the state variables or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. Do not modify or
free it or its contents.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-service-introspection-get-state-variable" role="function">
<title>gupnp_service_introspection_get_state_variable ()</title>
<indexterm zone="gupnp-service-introspection-get-state-variable"><primary>gupnp_service_introspection_get_state_variable</primary></indexterm><programlisting>const <link linkend="GUPnPServiceStateVariableInfo">GUPnPServiceStateVariableInfo</link>* gupnp_service_introspection_get_state_variable
                                                        (<link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
                                                         const <link linkend="gchar">gchar</link> *variable_name);</programlisting>
<para>
Returns the state variable by the name <parameter>variable_name</parameter> in this service.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>introspection</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable_name</parameter>&nbsp;:</term>
<listitem><simpara> The name of the variable to retreive
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the state variable or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. Do not modify or free it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GUPnPServiceIntrospection.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GUPnPServiceIntrospection--scpd"><title>The <literal>&quot;scpd&quot;</literal> property</title>
<indexterm zone="GUPnPServiceIntrospection--scpd"><primary>GUPnPServiceIntrospection:scpd</primary></indexterm><programlisting>  &quot;scpd&quot;                     <link linkend="gpointer">gpointer</link>              : Write / Construct Only</programlisting>
<para>
The scpd of the device description file.</para>
<para>

</para></refsect2>

</refsect1>




</refentry>