php-doc-en/reference/com/ini.xml
Wez Furlong 1f1450f2f7 Document PHP 4 and PHP 5 stuff in the COM extension.
# win32 users, you all owe me beer ;)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@157837 c90b9560-bf6c-de11-be94-00142212c4b1
2004-05-03 14:55:02 +00:00

187 lines
5.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<section id="com.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Com configuration options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
</row>
</thead>
<tbody>
<row>
<entry>com.allow_dcom</entry>
<entry>"0"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>com.autoregister_typelib</entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>com.autoregister_verbose</entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>com.autoregister_casesensitive</entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>com.code_page</entry>
<entry>""</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>com.typelib_file</entry>
<entry>""</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
</tbody>
</tgroup>
</table>
For further details and definition of the PHP_INI_* constants see
<function>ini_set</function>.
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry id="ini.com.allow-dcom">
<term>
<parameter>com.allow_dcom</parameter>
</term>
<listitem>
<para>
When this is turned on, PHP will be allowed to operate as a D-COM
(Distributed COM) client and will allow the PHP script to instantiate
COM objects on a remote server.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.com.autoregister-typelib">
<term>
<parameter>com.autoregister_typelib</parameter>
</term>
<listitem>
<para>
When this is turned on, PHP will attempt to register constants from
the typelibrary of objects that it instantiates, if those objects
implement the interfaces required to obtain that information.
The case sensitivity of the constants it registers is controlled by the
<xref
linkend="ini.com.autoregister-casesensitive"/> configuration directive.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.com.autoregister-verbose">
<term>
<parameter>com.autoregister_verbose</parameter>
</term>
<listitem>
<para>
When this is turned on, any problems with loading a typelibrary during
object instantiation will be reported using the PHP error mechanism.
The default is off, which does not emit any indication if there was
an error finding or loading the type library.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.com.autoregister-casesensitive">
<term>
<parameter>com.autoregister_casesensitive</parameter>
</term>
<listitem>
<para>
When this is turned on (the default), constants found in auto-loaded
type libraries will be registered case sensitively. See
<function>com_load_typelib</function> for more details.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.com.code-page">
<term>
<parameter>com.code_page</parameter>
</term>
<listitem>
<para>
It controls the default character set code-page to use when passing
strings to and from COM objects. If set to an empty string, PHP will
assume that you want <constant>CP_ACP</constant>, which is the default
system ANSI code page.
</para>
<para>
If the text in your scripts is encoded using a different
encoding/character set by default, setting this directive will save you
from having to pass the code page as a parameter to the <xref
linkend="class.com"/> class constructor. Please note that by
using this directive (as with any PHP configuration directive), your PHP
script becomes less portable; you should use the COM constructor parameter
whenever possible.
</para>
<note>
<simpara>
This configuration directive was introduced with PHP 5.
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry id="ini.com.typelib-file">
<term>
<parameter>com.typelib_file</parameter>
</term>
<listitem>
<para>
When set, this should hold the path to a file that contains a list
of typelibraries that should be loaded on startup. Each line of
the file will be treated as the type library name and loaded as
though you had called <function>com_load_typelib</function>.
The constants will be registered persistently, so that the library
only needs to be loaded once. If a type library name ends with the
string <literal>#cis</literal> or <literal>#case_insensitive</literal>,
then the constants from that library will be registered case
insensitively.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->