fmk Wed Nov 14 14:04:15 2001 EDT
Added files:
/phpdoc/en/functions iisfunc.xml
Log:
Adding basic documentation for the IIS functions. More text to be added.
Index: phpdoc/en/functions/iisfunc.xml
+++ phpdoc/en/functions/iisfunc.xml
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<reference id="ref.iisfunc">
<title>IIS Administration functions</title>
<titleabbrev>IIS Functions</titleabbrev>
<partintro>
<simpara>
This extension is available for Win32 only. It provides functions
to administrate Microsoft Internet Information Server (IIS).
The extension includes function to create web sites and vertual
directories as well as configuring security and script mapping.
These functions have been added in PHP 4.
</simpara>
</partintro>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_get_server_by_path</function></funcdef>
<paramdef>string <parameter>path</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Each vertual 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>
</refentry>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_get_server_by_comment</function></funcdef>
<paramdef>string <parameter>comment</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_add_server</function></funcdef>
<paramdef>string <parameter>path</parameter></paramdef>
<paramdef>string <parameter>comment</parameter></paramdef>
<paramdef>string <parameter>server_ip</parameter></paramdef>
<paramdef>int <parameter>port</parameter></paramdef>
<paramdef>string <parameter>host_name</parameter></paramdef>
<paramdef>int <parameter>rights</parameter></paramdef>
<paramdef>int <parameter>start_server</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_remove_server</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.iis-set-dir-security">
<refnamediv>
<refname>iis_set_dir_security</refname>
<refpurpose>Sets Directory Security</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_set_dir_security</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
<paramdef>string <parameter>virtual_path</parameter></paramdef>
<paramdef>int <parameter>directory_flags</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.iis-get-dir-security">
<refnamediv>
<refname>iis_get_dir_security</refname>
<refpurpose>Gets Directory Security</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_get_dir_security</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
<paramdef>string <parameter>virtual_path</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.iis-set-server-rights">
<refnamediv>
<refname>iis_set_server_rights</refname>
<refpurpose>Sets server rights</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_set_server_rights</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
<paramdef>string <parameter>virtual_path</parameter></paramdef>
<paramdef>int <parameter>directory_flags</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.iis-get-server-rights">
<refnamediv>
<refname>iis_get_server_rights</refname>
<refpurpose>Gets server rights</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_get_server_rights</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
<paramdef>string <parameter>virtual_path</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_set_script_map</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
<paramdef>string <parameter>virtual_path</parameter></paramdef>
<paramdef>string <parameter>script_extension</parameter></paramdef>
<paramdef>string <parameter>engine_path</parameter></paramdef>
<paramdef>int <parameter>allow_scripting</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<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
extention</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_get_script_map</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
<paramdef>string <parameter>virtual_path</parameter></paramdef>
<paramdef>string <parameter>script_extension</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_set_app_settings</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
<paramdef>string <parameter>virtual_path</parameter></paramdef>
<paramdef>string <parameter>application_scope</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.iis-start-server">
<refnamediv>
<refname>iis_start_server</refname>
<refpurpose>Starts the virtual web server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_start_server</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.iis-stop-server">
<refnamediv>
<refname>iis_stop_server</refname>
<refpurpose>Stops the virtual web server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_stop_server</function></funcdef>
<paramdef>int <parameter>server_instance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_stop_service</function></funcdef>
<paramdef>string <parameter>service_id</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_start_service</function></funcdef>
<paramdef>string <parameter>service_id</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.iis-get-service-state">
<refnamediv>
<refname>iis_get_service_state/refname>
<refpurpose>Starts the service defined by ServiceId</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>iis_get_service_state</function></funcdef>
<paramdef>string <parameter>service_id</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
</reference>
<!-- 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
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
