php-doc-en/reference/gupnp/functions/gupnp-context-host-path.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.gupnp-context-host-path" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>gupnp_context_host_path</refname>
  <refpurpose>Start hosting</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>gupnp_context_host_path</methodname>
   <methodparam><type>resource</type><parameter>context</parameter></methodparam>
   <methodparam><type>string</type><parameter>local_path</parameter></methodparam>
   <methodparam><type>string</type><parameter>server_path</parameter></methodparam>
  </methodsynopsis>
  <para>
   Start hosting <parameter>local_path</parameter> at <parameter>server_path</parameter>. Files with the path <parameter>local_path</parameter>.LOCALE (if they exist) 
   will be served up when LOCALE is specified in the request's Accept-Language header.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       A context identifier, returned by <function>gupnp_context_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>local_path</parameter></term>
     <listitem>
      <para>
       Path to the local file or folder to be hosted.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>server_path</parameter></term>
     <listitem>
      <para>
       Web server path where <parameter>local_path</parameter> should be hosted.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Create new UPnP context and set host path</title>
    <programlisting role="php">
<![CDATA[
<?php

/* Create the UPnP context */
$context = gupnp_context_new();

if (!$context) {
 die("Error creating the GUPnP context\n");
}

/* Host current directory */
gupnp_context_host_path($context, "./web", "");

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>gupnp_context_new</function></member>
    <member><function>gupnp_context_unhost_path</function></member>
   </simplelist>
  </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
-->