mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
407a2595a9
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294391 c90b9560-bf6c-de11-be94-00142212c4b1
111 lines
2.7 KiB
XML
111 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.gupnp-device-info-get-service" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>gupnp_device_info_get_service</refname>
|
|
<refpurpose>Get the service with type</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>gupnp_device_info_get_service</methodname>
|
|
<methodparam><type>resource</type><parameter>root_device</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>type</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Get the service with type or false if no such device was found.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>root_device</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A root device identifier, returned by <function>gupnp_root_device_new</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The type of the service to be retrieved.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A service identifier.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Create new UPnP context and get device info service</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
/* Create the UPnP context */
|
|
$context = gupnp_context_new();
|
|
|
|
if (!$context) {
|
|
die("Error creating the GUPnP context\n");
|
|
}
|
|
|
|
/* Create root device */
|
|
$location = "/BinaryLight1.xml";
|
|
$dev = gupnp_root_device_new($context, $location);
|
|
|
|
/* Set root device is available */
|
|
gupnp_root_device_set_available($dev, true);
|
|
|
|
/* Get the switch service from the root device */
|
|
$service_type = "urn:schemas-upnp-org:service:SwitchPower:1";
|
|
$service = gupnp_device_info_get_service($dev, $service_type);
|
|
if (!$service) {
|
|
die("Cannot get SwitchPower1 service\n");
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|