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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.printer-list" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>printer_list</refname>
<refpurpose>Return an array of printers attached to the server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>enumtype</parameter></term>
<listitem>
<para>
<parameter>enumtype</parameter> must be one of the following predefined
constants:
<itemizedlist>
<listitem>
<simpara>
<constant>PRINTER_ENUM_LOCAL</constant>:
enumerates the locally installed printers.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_ENUM_NAME</constant>:
enumerates the printer of <parameter>name</parameter>, can be a server,
domain or print provider.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_ENUM_SHARED</constant>:
this parameter can't be used alone, it has to be OR'ed with other
parameters, i.e. <constant>PRINTER_ENUM_LOCAL</constant> to detect the locally shared
printers.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_ENUM_DEFAULT</constant>:
(Win9.x only) enumerates the default printer.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_ENUM_CONNECTIONS</constant>:
(WinNT/2000 only) enumerates the printers to which the user has
made connections.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_ENUM_NETWORK</constant>:
(WinNT/2000 only) enumerates network printers in the computer's
domain. Only valid if <parameter>level</parameter> is 1.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PRINTER_ENUM_REMOTE</constant>:
(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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Used with <constant>PRINTER_ENUM_NAME</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>level</parameter></term>
<listitem>
<para>
<parameter>level</parameter> sets the level of information request.
Can be 1,2,4 or 5.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return an array of printers.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<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>
</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:"~/.phpdoc/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
-->
|