File: com.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (492 lines) | stat: -rw-r--r-- 16,121 bytes parent folder | download
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- EN-Revision: 1.31 Maintainer: tom Status: ready -->
<reference id="ref.com">
 <title>COM Support Funktionen fr Windows</title>
 <titleabbrev>COM</titleabbrev>
  <partintro>
   <simpara>
    Das Component Object Model (COM) ist eine Technologie, welche die
    Wiederverwendung von Code erlaubt, egal in welcher Sprache dieser
    geschrieben wurde. Die Komponenten stellen Schnittstellen bereit,
    welche die verfgbaren Funktionen, aber nicht deren Implementierung
    bekanntgeben (z.B. auf welcher Maschine die Komponente gespeichert
    ist und die Executable, die sie enthlt). Anwendungen knnen ber
    die COM-API beliebige Schnittstellen erzeugen. Man sich das wie einen
    super Remote Procedure Call (RPC) Mechanismus mit einigen grundlegenden
    Objekten vorstellen. Es trennt die Implementation von der Schnittstelle.
   </simpara>
   <simpara>
    COM untersttzt Versioning, die Trennung von Implementation und
    Schnittstelle, sowie das Verstecken von Implementierungsdetails, wie
    z.B. Position der Executable und die Sprache, in welcher die Komponente
    geschrieben wurde.
   </simpara>
   <simpara>
    Die COM Funktionen sind nur in der Windowsversion von PHP verfgbar.
   </simpara>
   <simpara>
    Weitere Informationen zu COM finden Sie in der 
    <ulink url="&url.comspecs;">COM specification</ulink>, oder in Don 
    Box's <ulink url="&url.yacl;"> Yet Another COM Library (YACL)</ulink>.
   </simpara>
  </partintro>
 
 <refentry id="class.com">
  <refnamediv>
   <refname>COM</refname>
   <refpurpose>COM Klasse</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
  <synopsis>$obj = new <classname>COM</classname>("server.object")</synopsis>
  </refsynopsisdiv>
  <refsect1 id="class.com.class">
   <title>Beschreibung</title>
   <simpara>
    Die COM Klasse bietet ein Gerst zur Integration von (D)COM Komponenten
    in Ihre PHP Skripte.
   </simpara>
  </refsect1>
  <refsect1 id="class.com.constructor">
   <title>Methoden</title>
    <methodsynopsis>
     <type>string</type><methodname>COM::COM</methodname>
     <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
     <methodparam choice="opt"><type>string</type><parameter>server_name</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam>
    </methodsynopsis>
   <para>
    COM Klassen Konstruktor. Parameter:
    <variablelist>
    <varlistentry><term>module_name</term>
    <listitem>
     <simpara>
      Name oder Klassen-ID der gewnschten Komponente.
     </simpara>
    </listitem>
    </varlistentry>
    <varlistentry><term>server_name</term>
    <listitem>
     <simpara>
      Name des DCOM Servers, von welchem die Komponente geholt werden soll.
      Ist &null; angegeben, wird <literal>localhost</literal> angenommen.
      Um DCOM zuzulassen, muss <constant>com.allow_dcom</constant>
      in der <filename>php.ini</filename> auf &true; 
      gesetzt sein.
     </simpara>
    </listitem>
    </varlistentry>
    <varlistentry><term>codepage</term>
    <listitem>
     <simpara>
      Spezifiziert die Codepage, welche zur Konvertierung der PHP-Strings in 
      Unicode-Strings und umgekehrt verwendet wird. Mgliche Werte sind 
      <constant>CP_ACP</constant>, <constant>CP_MACCP</constant>,
      <constant>CP_OEMCP</constant>, <constant>CP_SYMBOL</constant>,
      <constant>CP_THREAD_ACP</constant>, <constant>CP_UTF7</constant>
      und <constant>CP_UTF8</constant>.
     </simpara>
    </listitem>
    </varlistentry>
    </variablelist>
   </para>
   <para>
    <example id="example.com1">
     <title>COM Beispiel (1)</title>
     <programlisting role="php">
<![CDATA[
// Word starten
$word = new COM("word.application") or die("Konnte Word nicht instantiieren");
print "Word geladen, Version {$word->Version}\n";

//Fenster anzeigen
$word->Visible = 1;

//ein leeres Dokument ffnen
$word->Documents->Add();

//irgendetwas tun
$word->Selection->TypeText("Dies ist ein Test...");
$word->Documents[1]->SaveAs("Useless test.doc");

//Word schlieen
$word->Quit();

//Das Objekt freigeben
$word->Release();
$word = null;
]]>
     </programlisting>
    </example>
   </para>
   <para>
    <example id="example.com2">
     <title>COM example (2)</title>
     <programlisting role="php">
<![CDATA[
$conn = new COM("ADODB.Connection") or die("Cannot start ADO");
$conn->Open("Provider=SQLOLEDB; Data Source=localhost;
Initial Catalog=database; User ID=user; Password=password");

$rs = $conn->Execute("SELECT * FROM sometable");    // Recordset

$num_columns = $rs->Fields->Count();
echo $num_columns . "\n";

for ($i=0; $i < $num_columns; $i++)
{
    $fld[$i] = $rs->Fields($i);
}

$rowcount = 0;
while (!$rs->EOF)
{
    for ($i=0; $i < $num_columns; $i++)
    {
        echo $fld[$i]->value . "\t";
    }
    echo "\n";
    $rowcount++;            // increments rowcount
    $rs->MoveNext();
}

$rs->Close();
$conn->Close();

$rs->Release();
$conn->Release();

$rs = null;
$conn = null;
]]>
     </programlisting>
    </example>
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="class.variant">
  <refnamediv>
   <refname>VARIANT</refname>
   <refpurpose>VARIANT Klasse</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
  <synopsis>$vVar = new <classname>VARIANT</classname>($var)</synopsis>
  </refsynopsisdiv>
  <refsect1 id="class.variant.class">
   <title>Beschreibung</title>
   <simpara>
    Ein einfacher Container, um Variablen VARIANT Strukturen zu verpacken.
   </simpara>
  </refsect1>
  <refsect1 id="class.variant.constructor">
   <title>Methoden</title>
    <methodsynopsis>
     <type>string</type><methodname>VARIANT::VARIANT</methodname>
     <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam>
    </methodsynopsis>
   <para>
    VARIANT Klassen-Konstruktor. Parameter:
    <variablelist>
    <varlistentry><term>value</term>
    <listitem>
     <simpara>
      Anfangswert. Ist er nicht angegeben, wird ein VT_EMPTY Objekt erzeugt.
     </simpara>
    </listitem>
    </varlistentry>
    <varlistentry><term>type</term>
    <listitem>
     <simpara>
      spezifiziert den Typ vom Inhalt des VARIANT Objektes. Mgliche Werte sind
      <constant>VT_UI1</constant>, <constant>VT_UI2</constant>, <constant>VT_UI4</constant>, 
      <constant>VT_I1</constant>, <constant>VT_I2</constant>, <constant>VT_I4</constant>, 
      <constant>VT_R4</constant>, <constant>VT_R8</constant>, <constant>VT_INT</constant>, <constant>VT_UINT</constant>,
      <constant>VT_BOOL</constant>, <constant>VT_ERROR</constant>, <constant>VT_CY</constant>, 
      <constant>VT_DATE</constant>, <constant>VT_BSTR</constant>, <constant>VT_DECIMAL</constant>, 
      <constant>VT_UNKNOWN</constant>, <constant>VT_DISPATCH</constant> und <constant>VT_VARIANT</constant>.
      Diese Werte sind wechselseitig exklusiv, knnen aber mit <constant>VT_BYREF</constant>
      vereinigt werden, um zu spezifizieren, dass es sich um einen Wert handelt. 
      Wird er weggelassen, wird der Typ von <parameter>value</parameter> verwendet.
      Konsultieren Sie bitte die MSDN Library fr weitere Informationen.
     </simpara>
    </listitem>
    </varlistentry>
    <varlistentry><term>codepage</term>
    <listitem>
     <simpara>
      gibt die Codepage an, welche zur Konvertierung der PHP-Strings in
      Unicode-Strings und umgekehrt verwendet wird. Mgliche Werte sind 
      <constant>CP_ACP</constant>, <constant>CP_MACCP</constant>,
      <constant>CP_OEMCP</constant>, <constant>CP_SYMBOL</constant>,
      <constant>CP_THREAD_ACP</constant>, <constant>CP_UTF7</constant>
      und <constant>CP_UTF8</constant>.
     </simpara>
    </listitem>
    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-load">
  <refnamediv>
   <refname>com_load</refname>
   <refpurpose>
    Erstellt eine neue Referenz auf eine COM Komponente
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>string</type><methodname>com_load</methodname>
     <methodparam><type>string</type><parameter>module name</parameter></methodparam>
     <methodparam choice="opt"><type>string</type><parameter>
      server name
      </parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>
      codepage
      </parameter></methodparam>
    </methodsynopsis>
   <para>
    <function>com_load</function> erstellt eine neue COM Komponente, 
    und gibt eine Referenz darauf zurck. Im Fehlerfall wird 
    &false; zurckgegeben. Mgliche Werte fr 
    <parameter>codepage</parameter> sind
    <constant>CP_ACP</constant>, <constant>CP_MACCP</constant>,
    <constant>CP_OEMCP</constant>, <constant>CP_SYMBOL</constant>,
    <constant>CP_THREAD_ACP</constant>, <constant>CP_UTF7</constant>,
    und <constant>CP_UTF8</constant>.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-invoke">
  <refnamediv>
   <refname>com_invoke</refname>
   <refpurpose>
    Ruft eine Methode einer COM Komponente auf
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>mixed</type><methodname>com_invoke</methodname>
     <methodparam><type>resource</type><parameter>com_object</parameter></methodparam>
     <methodparam><type>string</type><parameter>function_name</parameter></methodparam>
     <methodparam choice="opt"><type>mixed</type><parameter>
      function parameters, ...
      </parameter></methodparam>
    </methodsynopsis>
   <para>
    <function>com_invoke</function> ruft eine Methode des mittels 
    <parameter>com_object</parameter> referenzierten COM Komponente auf.
    Gibt bei Erfolg den Rckgabewert von <parameter>function_name</parameter>,
    oder im Fehlerfall &false; zurck.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-propget">
  <refnamediv>
   <refname>com_propget</refname>
   <refpurpose>
    Liefert den Wert der Eigenschaft einer COM Komponente
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>mixed</type><methodname>com_propget</methodname>
     <methodparam><type>resource</type><parameter>com_object</parameter></methodparam>
     <methodparam><type>string</type><parameter>property</parameter></methodparam>
    </methodsynopsis>
   <para>
    Diese Funktion ist ein Alias von <function>com_get</function>.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-get">
  <refnamediv>
   <refname>com_get</refname>
   <refpurpose>
    Liefert den Wert der Eigenschaft einer COM Komponente
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>mixed</type><methodname>com_get</methodname>
     <methodparam><type>resource</type><parameter>com_object</parameter></methodparam>
     <methodparam><type>string</type><parameter>property</parameter></methodparam>
    </methodsynopsis>
   <para>
    Liefert den Wert der Eigenschaft <parameter>property</parameter> der
    mittels <parameter>com_object</parameter> referenzierten COM Komponente.
    Gibt im Fehlerfall &false; zurck.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-propput">
  <refnamediv>
   <refname>com_propput</refname>
   <refpurpose>
    Weist einer Eigenschaft einer COM Komponente einen Wert zu 
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>void</type><methodname>com_propput</methodname>
     <methodparam><type>resource</type><parameter>com_object</parameter></methodparam>
     <methodparam><type>string</type><parameter>property</parameter></methodparam>
     <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
    </methodsynopsis>
   <para>
    Diese Funktion ist ein Alias fr <function>com_set</function>.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-propset">
  <refnamediv>
   <refname>com_propset</refname>
   <refpurpose>
    Weist einer Eigenschaft einer COM Komponente einen Wert zu 
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>void</type><methodname>com_propset</methodname>
     <methodparam><type>resource</type><parameter>com_object</parameter></methodparam>
     <methodparam><type>string</type><parameter>property</parameter></methodparam>
     <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
    </methodsynopsis>
   <para>
    Diese Funktion ist ein Alias fr <function>com_set</function>.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-set">
  <refnamediv>
   <refname>com_set</refname>
   <refpurpose>
    Weist einer Eigenschaft einer COM Komponente einen Wert zu.
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>void</type><methodname>com_set</methodname>
     <methodparam><type>resource</type><parameter>com_object</parameter></methodparam>
     <methodparam><type>string</type><parameter>property</parameter></methodparam>
     <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
    </methodsynopsis>
   <para>
    Setzt den Wert der Eigenschaft <parameter>property</parameter> der COM
    Komponente <parameter>com_object</parameter>. Gibt bei Erfolg den neu gesetzten 
    Wert, oder im Fehlerfall &false; zurck.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-addref">
  <refnamediv>
   <refname>com_addref</refname>
   <refpurpose>
    Erhht den Referenzzhler der Komponente
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
      <type>void</type><methodname>com_addref</methodname>
      <void/>
    </methodsynopsis>
   <para>
    Erhht den Referenzzhler der Komponente.
   </para>
  </refsect1>
 </refentry>
 
 <refentry id="function.com-release">
  <refnamediv>
   <refname>com_release</refname>
   <refpurpose>
    Reduziert den Referenzzhler der Komponente
   </refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
      <type>void</type><methodname>com_release</methodname>
      <void/>
    </methodsynopsis>
   <para>
    Reduziert den Referenzzhler der Komponente.
   </para>
  </refsect1>
 </refentry>

  <refentry id='function.com-isenum'>
   <refnamediv>
    <refname>com_isenum</refname>
    <refpurpose>Holt eine IEnumVariant</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>void</type><methodname>com_isenum</methodname>
      <methodparam><type>object</type><parameter>com_module</parameter></methodparam>
     </methodsynopsis>
    <para>
     &warn.undocumented.func;
    </para>
   </refsect1>
  </refentry>

  <refentry id='function.com-load-typelib'>
   <refnamediv>
    <refname>com_load_typelib</refname>
    <refpurpose>Ldt eine Typelib</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>void</type><methodname>com_load_typelib</methodname>
      <methodparam><type>string</type><parameter>typelib_name</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>case_insensitive</parameter></methodparam>
     </methodsynopsis>
    <para>
     &warn.undocumented.func;
    </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
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
-->