<!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>Start hosting</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-context-get-subscription-timeout.html">gupnp_context_get_subscription_timeout</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-context-new.html">gupnp_context_new</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-context-host-path" class="refentry">
<div class="refnamediv">
<h1 class="refname">gupnp_context_host_path</h1>
<p class="verinfo">(PECL gupnp >= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_context_host_path</span> — <span class="dc-title">Start hosting</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gupnp-context-host-path-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>gupnp_context_host_path</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$local_path</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$server_path</code></span>
)</div>
<p class="para rdfs-comment">
Start hosting <em><code class="parameter">local_path</code></em> at <em><code class="parameter">server_path</code></em>. Files with the path <em><code class="parameter">local_path</code></em>.LOCALE (if they exist)
will be served up when LOCALE is specified in the request's Accept-Language header.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gupnp-context-host-path-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">context</code></em></span>
<dd>
<p class="para">
A context identifier, returned by <span class="function"><a href="function.gupnp-context-new.html" class="function">gupnp_context_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">local_path</code></em></span>
<dd>
<p class="para">
Path to the local file or folder to be hosted.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">server_path</code></em></span>
<dd>
<p class="para">
Web server path where <em><code class="parameter">local_path</code></em> should be hosted.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-context-host-path-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gupnp-context-host-path-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4342">
<p><strong>Example #1 Create new UPnP context and set host path</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">/* Host current directory */<br /></span><span style="color: #0000BB">gupnp_context_host_path</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">, </span><span style="color: #DD0000">"./web"</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.gupnp-context-host-path-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.gupnp-context-new.html" class="function" rel="rdfs-seeAlso">gupnp_context_new()</a> - Create a new context</span></li>
<li class="member"> <span class="function"><a href="function.gupnp-context-unhost-path.html" class="function" rel="rdfs-seeAlso">gupnp_context_unhost_path()</a> - Stop hosting</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-context-get-subscription-timeout.html">gupnp_context_get_subscription_timeout</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-context-new.html">gupnp_context_new</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>
