winspool: Add Documentation for the Port-Functions

[Detlef Riekenberg]

First try with git :-)


Changelog:
 - Add Documentation for the Port-Functions


-- 
By By ...
      ... Detlef


---

 dlls/winspool/info.c |  118
+++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 116 insertions(+), 2 deletions(-)

applies-to: c87e1558efd42dc4f2b6cfcb9ef2c1a69edc88f6
bd04d0ff3f102acc68a65800d3608f0947064e73
diff --git a/dlls/winspool/info.c b/dlls/winspool/info.c
index 3bdd01d..70a1e39 100644
--- a/dlls/winspool/info.c
+++ b/dlls/winspool/info.c
@@ -1192,6 +1192,13 @@ DeleteMonitorW (LPWSTR pName, LPWSTR pEn
 /******************************************************************
  *              DeletePortA        [WINSPOOL.@]
  *
+ * Delete a specific Port (ANSI)
+ *
+ * See DeletePortW.
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI
 DeletePortA (LPSTR pName, HWND hWnd, LPSTR pPortName)
@@ -1205,6 +1212,20 @@ DeletePortA (LPSTR pName, HWND hWnd, LPS
 /******************************************************************
  *              DeletePortW        [WINSPOOL.@]
  *
+ * Delete a specific Port (UNICODE)
+ *
+ * PARAMS
+ *  pName     [I] Servername or NULL (local Computer)
+ *  hWnd      [I] Handle to parent Window for the Dialog-Box
+ *  pPortName [I] Name of the Port, that should be deleted
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI
 DeletePortW (LPWSTR pName, HWND hWnd, LPWSTR pPortName)
@@ -3733,6 +3754,14 @@ static DWORD WINSPOOL_CountSerialPorts(v
 
 /******************************************************************************
  *		EnumPortsA   (WINSPOOL.@)
+ *
+ * Enumerate available Ports (ANSI)
+ *
+ * See EnumPortsW.
+ *
+ * BUGS
+ *  ANSI-Version did not call the UNICODE-Version
+ *
  */
 BOOL WINAPI EnumPortsA(LPSTR name,DWORD level,LPBYTE buffer,DWORD
bufsize,
                        LPDWORD bufneeded,LPDWORD bufreturned)
@@ -3850,6 +3879,24 @@ BOOL WINAPI EnumPortsA(LPSTR name,DWORD 
 
 /******************************************************************************
  *      EnumPortsW   (WINSPOOL.@)
+ *
+ * Enumerate available Ports (UNICODE)
+ *
+ * PARAMS
+ *  name        [I] Servername or NULL (local Computer)
+ *  level       [I] Structure-Level (1 or 2)
+ *  buffer      [O] PTR to Buffer that receives the Result
+ *  bufsize     [I] Size of Buffer at buffer
+ *  bufneeded   [O] PTR to DWORD that receives the size in Bytes used /
required for buffer
+ *  bufreturned [O] PTR to DWORD that receives the number of Ports in
buffer
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE and in bufneeded the Bytes required for buffer, if
bufsize is too small
+ *
+ * BUGS
+ *  UNICODE-Version is a stub
+ *
  */
 BOOL WINAPI EnumPortsW(LPWSTR name,DWORD level,LPBYTE buffer,DWORD
bufsize,
                        LPDWORD bufneeded,LPDWORD bufreturned)
@@ -4511,6 +4558,14 @@ BOOL WINAPI AbortPrinter( HANDLE hPrinte
 
 /******************************************************************************
  *		AddPortA (WINSPOOL.@)
+ *
+ * Add a Port for by a specific Monitor (UNICODE)
+ *
+ * See AddPortW.
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI AddPortA(LPSTR pName, HWND hWnd, LPSTR pMonitorName)
 {
@@ -4520,6 +4575,21 @@ BOOL WINAPI AddPortA(LPSTR pName, HWND h
 
 /******************************************************************************
  *      AddPortW (WINSPOOL.@)
+ *
+ * Add a Port for a specific Monitor (UNICODE)
+ *
+ * PARAMS
+ *  pName        [I] Servername or NULL (local Computer)
+ *  hWnd         [I] Handle to parent Window for the Dialog-Box
+ *  pMonitorName [I] Name of the Monitor that manage the Port
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI AddPortW(LPWSTR pName, HWND hWnd, LPWSTR pMonitorName)
 {
@@ -4530,7 +4600,13 @@ BOOL WINAPI AddPortW(LPWSTR pName, HWND 
 /******************************************************************************
  *             AddPortExA (WINSPOOL.@)
  *
- * Adds a print spooler port without presenting a user interface.
+ * Add a Port for a specific Monitor, without presenting a user
interface (ANSI)
+ *
+ * See AddPortExW.
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI AddPortExA(HANDLE hMonitor, LPSTR pName, DWORD Level,
LPBYTE lpBuffer, LPSTR lpMonitorName)
 {
@@ -4542,7 +4618,22 @@ BOOL WINAPI AddPortExA(HANDLE hMonitor, 
 /******************************************************************************
  *             AddPortExW (WINSPOOL.@)
  *
- * See AddPortExW.
+ * Add a Port for a specific Monitor, without presenting a user
interface (UNICODE)
+ *
+ * PARAMS
+ *  hMonitor      [I] Handle from InitializePrintMonitor2()
+ *  pName         [I] Servername or NULL (local Computer)
+ *  Level         [I] Structure-Level (1 or 2) for lpBuffer
+ *  lpBuffer      [I] PTR to: PORT_INFO_1 or PORT_INFO_2
+ *  lpMonitorName [I] Name of the Monitor that manage the Port or NULL
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI AddPortExW(HANDLE hMonitor, LPWSTR pName, DWORD Level,
LPBYTE lpBuffer, LPWSTR lpMonitorName)
 {
@@ -4595,6 +4686,14 @@ BOOL WINAPI AddPrinterDriverExA( LPSTR p
 
 /******************************************************************************
  *      ConfigurePortA (WINSPOOL.@)
+ *
+ * Display the Configuration-Dialog for a specific Port (ANSI)
+ *
+ * See ConfigurePortW.
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI ConfigurePortA(LPSTR pName, HWND hWnd, LPSTR pPortName)
 {
@@ -4604,6 +4703,21 @@ BOOL WINAPI ConfigurePortA(LPSTR pName, 
 
 /******************************************************************************
  *      ConfigurePortW (WINSPOOL.@)
+ *
+ * Display the Configuration-Dialog for a specific Port (UNICODE)
+ *
+ * PARAMS
+ *  pName     [I] Servername or NULL (local Computer)
+ *  hWnd      [I] Handle to parent Window for the Dialog-Box
+ *  pPortName [I] Name of the Port, that should be configured
+ *
+ * RETURNS
+ *  Success: TRUE
+ *  Failure: FALSE
+ *
+ * BUGS
+ *  only a Stub
+ *
  */
 BOOL WINAPI ConfigurePortW(LPWSTR pName, HWND hWnd, LPWSTR pPortName)
 {
---
0.99.9k