Home > PHP > Function > Printer > printer_start_doc()

printer_start_doc()

printer_start_doc - Start a new document

Syntax

bool printer_start_doc (resource $printer_handle, string $document)

Arguments

  • printer_handle - printer_handle must be a valid printer handle.
  • document - The optional parameter document can be used to set an alternative document name.

Description

The function creates a new document in the printer spooler. A document can contain multiple pages, it's used to schedule the print job in the spooler.

Version

PHP PECL printer SVN

Return value

Returns TRUE on success or FALSE on failure.