File: printer-list.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (107 lines) | stat: -rw-r--r-- 3,484 bytes parent folder | download | duplicates (2)
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.4 $ -->
<!-- splitted from ./en/functions/printer.xml, last change in rev 1.6 -->
  <refentry id="function.printer-list">
   <refnamediv>
    <refname>printer_list</refname>
    <refpurpose>Return an array of printers attached to the server
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
      <methodsynopsis>
       <type>array</type><methodname>printer_list</methodname>
       <methodparam><type>int</type><parameter>enumtype</parameter></methodparam>
       <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam>
      </methodsynopsis>
    <para>
     The function enumerates available printers and their capabilities.
     <parameter>level</parameter> sets the level of information request. 
     Can be 1,2,4 or 5. <parameter>enumtype</parameter> must be one of the 
     following predefined constants:
     <itemizedlist>
      <listitem>
       <simpara>
        <parameter>PRINTER_ENUM_LOCAL</parameter>:
        enumerates the locally installed printers.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <parameter>PRINTER_ENUM_NAME</parameter>:
        enumerates the printer of <parameter>name</parameter>, can be a server, 
        domain or print provider.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <parameter>PRINTER_ENUM_SHARED</parameter>:
        this parameter can't be used alone, it has to be OR'ed with other 
        parameters, i.e. PRINTER_ENUM_LOCAL to detect the locally shared 
        printers.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <parameter>PRINTER_ENUM_DEFAULT</parameter>:
        (Win9.x only) enumerates the default printer.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <parameter>PRINTER_ENUM_CONNECTIONS</parameter>:
        (WinNT/2000 only) enumerates the printers to which the user has 
        made connections.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <parameter>PRINTER_ENUM_NETWORK</parameter>:
        (WinNT/2000 only) enumerates network printers in the computer's 
        domain. Only valid if <parameter>level</parameter> is 1.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <parameter>PRINTER_ENUM_REMOTE</parameter>:
        (WinNT/2000 only) enumerates network printers and print servers in the 
        computer's domain. Only valid if <parameter>level</parameter> is 1.
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <example>
     <title><function>printer_list</function> example</title>
     <programlisting role="php">
<![CDATA[
<?php
/* detect locally shared printer */
var_dump(printer_list(PRINTER_ENUM_LOCAL | PRINTER_ENUM_SHARED));
?>
]]>
     </programlisting>
    </example>      
   </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
-->