Detlef Riekenberg : winspool: Added documentation for OpenPrinter.

[Alexandre Julliard]

Module: wine
Branch: refs/heads/master
Commit: dd6aa8cf2d5247458ff6322a300582d1149e8a46
URL:    http://source.winehq.org/git/?p=wine.git;a=commit;h=dd6aa8cf2d5247458ff6322a...

Author: Detlef Riekenberg 
Date:   Mon Dec 12 12:10:13 2005 +0100

winspool: Added documentation for OpenPrinter.

---

dlls/winspool/info.c |   28 ++++++++++++++++++++++++++++
 1 files changed, 28 insertions(+), 0 deletions(-)

diff --git a/dlls/winspool/info.c b/dlls/winspool/info.c
index f1d05c1..9b1771d 100644
--- a/dlls/winspool/info.c
+++ b/dlls/winspool/info.c
@@ -1039,6 +1039,8 @@ LONG WINAPI DocumentPropertiesW(HWND hWn
 /******************************************************************
  *              OpenPrinterA        [WINSPOOL.@]
  *
+ * See OpenPrinterW.
+ *
  */
 BOOL WINAPI OpenPrinterA(LPSTR lpPrinterName,HANDLE *phPrinter,
    		 LPPRINTER_DEFAULTSA pDefault)
@@ -1069,6 +1071,32 @@ BOOL WINAPI OpenPrinterA(LPSTR lpPrinter
 /******************************************************************
  *              OpenPrinterW        [WINSPOOL.@]
  *
+ * Open a Printer / Printserver or a Printer-Object
+ *
+ * PARAMS
+ *  lpPrinterName [I] Name of Printserver, Printer, or Printer-Object
+ *  phPrinter     [O] The resulting Handle is stored here
+ *  pDefault      [I] PTR to Default Printer Settings or NULL
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE
+ *
+ * NOTES
+ *  lpPrinterName is one of:
+ *|  Printserver (NT only): "Servername" or NULL for the local Printserver
+ *|  Printer: "PrinterName"
+ *|  Printer-Object: "PrinterName,Job xxx"
+ *|  XcvMonitor: "Servername,XcvMonitor MonitorName"
+ *|  XcvPort: "Servername,XcvPort PortName"
+ *
+ * BUGS
+ *|  Printserver not supported
+ *|  Printer-Object not supported
+ *|  XcvMonitor not supported
+ *|  XcvPort not supported
+ *|  pDefaults not supported
+ *
  */
 BOOL WINAPI OpenPrinterW(LPWSTR lpPrinterName,HANDLE *phPrinter,
    		 LPPRINTER_DEFAULTSW pDefault)