php-doc-en/reference/printer/functions/printer-list.xml
Hartmut Holzgraefe 5b9fc29465 revision tags added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 06:45:35 +00:00

105 lines
3.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- 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[
/* 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
-->