<!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><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-device-action-callback-set.html">gupnp_device_action_callback_set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-device-info-get.html">gupnp_device_info_get</a></div>
<div class="up"><a href="ref.gupnp.html">Gupnp Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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 >= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_device_info_get_service</span> — <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">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <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>
)</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">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">root_device</code></em></span>
<dd>
<p class="para">
A root device identifier, returned by <span class="function"><a href="function.gupnp-root-device-new.html" class="function">gupnp_root_device_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
The type of the service to be retrieved.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-device-info-get-service-returnvalues">
<h3 class="title">Return Values</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">Examples</h3>
<p class="para">
<div class="example" id="example-4347">
<p><strong>Example #1 Create new UPnP context and get device info service</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* Create the UPnP context */<br /></span><span style="color: #0000BB">$context </span><span style="color: #007700">= </span><span style="color: #0000BB">gupnp_context_new</span><span style="color: #007700">();<br /><br />if (!</span><span style="color: #0000BB">$context</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">"Error creating the GUPnP context\n"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Create root device */<br /></span><span style="color: #0000BB">$location </span><span style="color: #007700">= </span><span style="color: #DD0000">"/BinaryLight1.xml"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$dev </span><span style="color: #007700">= </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">, </span><span style="color: #0000BB">$location</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Set root device is available */<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">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Get the switch service from the root device */<br /></span><span style="color: #0000BB">$service_type </span><span style="color: #007700">= </span><span style="color: #DD0000">"urn:schemas-upnp-org:service:SwitchPower:1"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$service </span><span style="color: #007700">= </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">, </span><span style="color: #0000BB">$service_type</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$service</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">"Cannot get SwitchPower1 service\n"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-device-action-callback-set.html">gupnp_device_action_callback_set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-device-info-get.html">gupnp_device_info_get</a></div>
<div class="up"><a href="ref.gupnp.html">Gupnp Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
