1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.com-load-typelib' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_load_typelib</refname>
<refpurpose>Loads a Typelib</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>com_load_typelib</methodname>
<methodparam><type>string</type><parameter>typelib_name</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>case_insensitive</parameter></methodparam>
</methodsynopsis>
<para>
Loads a type-library and registers its constants in the engine, as though
they were defined using <function>define</function>.
</para>
<para>
Note that it is much more efficient to use the <xref
linkend="ini.com.typelib-file"/> configuration setting to pre-load and
register the constants, although not so flexible.
</para>
<para>
If you have turned on <xref linkend="ini.com.autoregister-typelib"/>, then
PHP will attempt to automatically register the constants associated with a
COM object when you instantiate it. This depends on the interfaces
provided by the COM object itself, and may not always be possible.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>typelib_name</parameter></term>
<listitem>
<para>
<parameter>typelib_name</parameter> can be one of the following:
<itemizedlist>
<listitem>
<para>
The filename of a <literal>.tlb</literal> file or the executable module
that contains the type library.
</para>
</listitem>
<listitem>
<para>
The type library GUID, followed by its version number, for example
<literal>{00000200-0000-0010-8000-00AA006D2EA4},2,0</literal>.
</para>
</listitem>
<listitem>
<para>
The type library name, e.g. <literal>Microsoft OLE DB ActiveX Data
Objects 1.0 Library</literal>.
</para>
</listitem>
</itemizedlist>
PHP will attempt to resolve the type library in this order, as the
process gets more and more expensive as you progress down the list;
searching for the type library by name is handled by physically
enumerating the registry until we find a match.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>case_insensitive</parameter></term>
<listitem>
<para>
The <parameter>case_insensitive</parameter> behaves in the same way as
the parameter with the same name in the <function>define</function>
function.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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:"../../../../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
-->
|
