uTools-Manuals/docs/php/gupnp_device_info_get_service.html
2019-04-28 19:00:34 +08:00

89 lines
5.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get the service with type</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.gupnp-device-info-get-service" class="refentry">
<div class="refnamediv">
<h1 class="refname">gupnp_device_info_get_service</h1>
<p class="verinfo">(PECL gupnp &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_device_info_get_service</span> &mdash; <span class="dc-title">Get the service with type</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gupnp-device-info-get-service-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>gupnp_device_info_get_service</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$root_device</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
) : <span class="type">resource</span></div>
<p class="para rdfs-comment">
Get the service with type or false if no such device was found.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gupnp-device-info-get-service-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">root_device</code></dt>
<dd>
<p class="para">
A root device identifier, returned by <span class="function"><a href="gupnp_root_device_new.html" class="function">gupnp_root_device_new()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">type</code></dt>
<dd>
<p class="para">
The type of the service to be retrieved.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-device-info-get-service-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
A service identifier.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gupnp-device-info-get-service-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-5375">
<p><strong>Example #1 Create new UPnP context and get device info service</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">/*&nbsp;Create&nbsp;the&nbsp;UPnP&nbsp;context&nbsp;*/<br /></span><span style="color: #0000BB">$context&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gupnp_context_new</span><span style="color: #007700">();<br /><br />if&nbsp;(!</span><span style="color: #0000BB">$context</span><span style="color: #007700">)&nbsp;{<br />&nbsp;die(</span><span style="color: #DD0000">"Error&nbsp;creating&nbsp;the&nbsp;GUPnP&nbsp;context\n"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/*&nbsp;Create&nbsp;root&nbsp;device&nbsp;*/<br /></span><span style="color: #0000BB">$location&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"/BinaryLight1.xml"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$dev&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gupnp_root_device_new</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$location</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*&nbsp;Set&nbsp;root&nbsp;device&nbsp;is&nbsp;available&nbsp;*/<br /></span><span style="color: #0000BB">gupnp_root_device_set_available</span><span style="color: #007700">(</span><span style="color: #0000BB">$dev</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*&nbsp;Get&nbsp;the&nbsp;switch&nbsp;service&nbsp;from&nbsp;the&nbsp;root&nbsp;device&nbsp;*/<br /></span><span style="color: #0000BB">$service_type&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"urn:schemas-upnp-org:service:SwitchPower:1"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$service&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gupnp_device_info_get_service</span><span style="color: #007700">(</span><span style="color: #0000BB">$dev</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$service_type</span><span style="color: #007700">);<br />if&nbsp;(!</span><span style="color: #0000BB">$service</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">"Cannot&nbsp;get&nbsp;SwitchPower1&nbsp;service\n"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
</div></div></div></body></html>