iisfunc: switch to new style

declare undocumented functions
document constants


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227255 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-01-15 01:50:07 +00:00
parent d4172b13ba
commit 5f6a4d77b1
18 changed files with 239 additions and 86 deletions

View file

@ -0,0 +1,150 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<section id="iisfunc.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>IIS_READ</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_WRITE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_EXECUTE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_SCRIPT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_ANONYMOUS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_BASIC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_NTLM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_STARTING</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_STOPPED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_PAUSED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>IIS_RUNNING</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- 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:"../../../../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
-->

View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-add-server">
<refnamediv>
<refname>iis_add_server</refname>
<refpurpose>Creates a new virtual web server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_add_server</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
@ -17,8 +17,7 @@
<methodparam><type>int</type><parameter>rights</parameter></methodparam>
<methodparam><type>int</type><parameter>start_server</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,19 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-get-dir-security">
<refnamediv>
<refname>iis_get_dir_security</refname>
<refpurpose>Gets Directory Security</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_get_dir_security</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
<methodparam><type>string</type><parameter>virtual_path</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,20 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.iis-get-script-map">
<refnamediv>
<refname>iis_get_script_map</refname>
<refpurpose>Gets script mapping on a virtual directory for a specific extension</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>iis_get_script_map</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
<methodparam><type>string</type><parameter>virtual_path</parameter></methodparam>
<methodparam><type>string</type><parameter>script_extension</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-get-server-by-comment">
<refnamediv>
<refname>iis_get_server_by_comment</refname>
<refpurpose>Return the instance number associated with the Comment</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_get_server_by_comment</methodname>
<methodparam><type>string</type><parameter>comment</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,20 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.iis-get-server-by-path">
<refnamediv>
<refname>iis_get_server_by_path</refname>
<refpurpose>Return the instance number associated with the Path</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_get_server_by_path</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
Each virtual server in IIS is associated with an instance number.
<function>iis_get_server_by_path</function> Finds the instance number
from the actual path to the root directory.
Each virtual server in IIS is associated with an instance number.
<function>iis_get_server_by_path</function> finds the instance number
from the actual path to the root directory.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
The path to the root directory
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the server instance number.
</para>
</refsect1>
</refentry>

View file

@ -1,19 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-get-server-rights">
<refnamediv>
<refname>iis_get_server_rights</refname>
<refpurpose>Gets server rights</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_get_server_rights</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
<methodparam><type>string</type><parameter>virtual_path</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.iis-get-service-state">
<refnamediv>
<refname>iis_get_service_state</refname>
<refpurpose>Returns the state for the service defined by ServiceId</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_get_service_state</methodname>
<methodparam><type>string</type><parameter>service_id</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-remove-server">
<refnamediv>
<refname>iis_remove_server</refname>
<refpurpose>Removes the virtual web server indicated by ServerInstance</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_remove_server</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,20 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-set-app-settings">
<refnamediv>
<refname>iis_set_app_settings</refname>
<refpurpose>Creates application scope for a virtual directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_set_app_settings</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
<methodparam><type>string</type><parameter>virtual_path</parameter></methodparam>
<methodparam><type>string</type><parameter>application_scope</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,20 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-set-dir-security">
<refnamediv>
<refname>iis_set_dir_security</refname>
<refpurpose>Sets Directory Security</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_set_dir_security</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
<methodparam><type>string</type><parameter>virtual_path</parameter></methodparam>
<methodparam><type>int</type><parameter>directory_flags</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-set-script-map">
<refnamediv>
<refname>iis_set_script_map</refname>
<refpurpose>Sets script mapping on a virtual directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_set_script_map</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
@ -15,8 +15,7 @@
<methodparam><type>string</type><parameter>engine_path</parameter></methodparam>
<methodparam><type>int</type><parameter>allow_scripting</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,20 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-set-server-rights">
<refnamediv>
<refname>iis_set_server_rights</refname>
<refpurpose>Sets server rights</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_set_server_rights</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
<methodparam><type>string</type><parameter>virtual_path</parameter></methodparam>
<methodparam><type>int</type><parameter>directory_flags</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-start-server">
<refnamediv>
<refname>iis_start_server</refname>
<refpurpose>Starts the virtual web server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_start_server</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-start-service">
<refnamediv>
<refname>iis_start_service</refname>
<refpurpose>Starts the service defined by ServiceId</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_start_service</methodname>
<methodparam><type>string</type><parameter>service_id</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-stop-server">
<refnamediv>
<refname>iis_stop_server</refname>
<refpurpose>Stops the virtual web server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_stop_server</methodname>
<methodparam><type>int</type><parameter>server_instance</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.iis-stop-service">
<refnamediv>
<refname>iis_stop_service</refname>
<refpurpose>Stops the service defined by ServiceId</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>iis_stop_service</methodname>
<methodparam><type>string</type><parameter>service_id</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- Purpose: utilspec.server -->
<!-- Membership: pecl -->
@ -50,10 +50,7 @@
&no.resource;
</section>
<section id="iisfunc.constants">
&reftitle.constants;
&no.constants;
</section>
&reference.iisfunc.constants;
</partintro>