Detlef Riekenberg : winspool: Document the monitor functions.

[Alexandre Julliard]

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

Author: Detlef Riekenberg 
Date:   Tue Dec  6 11:33:52 2005 +0100

winspool: Document the monitor functions.

---

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

diff --git a/dlls/winspool/info.c b/dlls/winspool/info.c
index a54fe32..f1d05c1 100644
--- a/dlls/winspool/info.c
+++ b/dlls/winspool/info.c
@@ -1119,6 +1119,8 @@ BOOL WINAPI OpenPrinterW(LPWSTR lpPrinte
 /******************************************************************
  *              AddMonitorA        [WINSPOOL.@]
  *
+ * See AddMonitorW.
+ *
  */
 BOOL WINAPI AddMonitorA(LPSTR pName, DWORD Level, LPBYTE pMonitors)
 {
@@ -1129,6 +1131,24 @@ BOOL WINAPI AddMonitorA(LPSTR pName, DWO

/******************************************************************************
  *              AddMonitorW        [WINSPOOL.@]
+ *
+ * Install a Printmonitor
+ *
+ * PARAMS
+ *  pName       [I] Servername or NULL (local Computer)
+ *  Level       [I] Structure-Level (Must be 2)
+ *  pMonitors   [I] PTR to MONITOR_INFO_2
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE
+ *
+ * NOTES
+ *  All Files for the Monitor must already be copied to %winsysdir% ("%SystemRoot%\system32")
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI AddMonitorW(LPWSTR pName, DWORD Level, LPBYTE pMonitors)
 {
@@ -1166,6 +1186,8 @@ DeletePrinterDriverW (LPWSTR pName, LPWS
 /******************************************************************
  *              DeleteMonitorA        [WINSPOOL.@]
  *
+ * See DeleteMonitorW.
+ *
  */
 BOOL WINAPI
 DeleteMonitorA (LPSTR pName, LPSTR pEnvironment, LPSTR pMonitorName)
@@ -1179,6 +1201,20 @@ DeleteMonitorA (LPSTR pName, LPSTR pEnvi
 /******************************************************************
  *              DeleteMonitorW        [WINSPOOL.@]
  *
+ * Delete a specific Printmonitor from a Printing-Environment
+ *
+ * PARAMS
+ *  pName        [I] Servername or NULL (local Computer)
+ *  pEnvironment [I] Printing-Environment of the Monitor or NULL (Default)
+ *  pMonitorName [I] Name of the Monitor, that should be deleted
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI
 DeleteMonitorW (LPWSTR pName, LPWSTR pEnvironment, LPWSTR pMonitorName)
@@ -4837,6 +4873,8 @@ BOOL WINAPI EnumFormsW( HANDLE hPrinter,
 /*****************************************************************************
  *          EnumMonitorsA [WINSPOOL.@]
  *
+ * See EnumMonitorsW.
+ *
  */
 BOOL WINAPI EnumMonitorsA(LPSTR pName, DWORD Level, LPBYTE pMonitors,
                           DWORD cbBuf, LPDWORD pcbNeeded, LPDWORD pcReturned)
@@ -4850,6 +4888,23 @@ BOOL WINAPI EnumMonitorsA(LPSTR pName, D
 /*****************************************************************************
  *          EnumMonitorsW [WINSPOOL.@]
  *
+ * Enumerate available Monitors
+ *
+ * PARAMS
+ *  pName       [I] Servername or NULL (local Computer)
+ *  Level       [I] Structure-Level (1:Win9x+NT or 2:NT only)
+ *  pMonitors   [O] PTR to Buffer that receives the Result
+ *  cbBuf       [I] Size of Buffer at pMonitors
+ *  pcbNeeded   [O] PTR to DWORD that receives the size in Bytes used / required for pMonitors
+ *  pcReturned  [O] PTR to DWORD that receives the number of Monitors in pMonitors
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE and in bufneeded the Bytes required for buffer, if bufsize is too small
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI EnumMonitorsW(LPWSTR pName, DWORD Level, LPBYTE pMonitors,
                           DWORD cbBuf, LPDWORD pcbNeeded, LPDWORD pcReturned)