Detlef Riekenberg : winspool: Add documentation for the port
functions.
Alexandre Julliard
julliard at wine.codeweavers.com
Tue Dec 6 04:37:25 CST 2005
Module: wine
Branch: refs/heads/master
Commit: 1395d14507f18aa2eb73653a2b5c358d5023eea3
URL: http://source.winehq.org/git/?p=wine.git;a=commit;h=1395d14507f18aa2eb73653a2b5c358d5023eea3
Author: Detlef Riekenberg <wine.dev at web.de>
Date: Tue Dec 6 10:57:01 2005 +0100
winspool: Add documentation for the port functions.
---
dlls/winspool/info.c | 96 +++++++++++++++++++++++++++++++++++++++++++++++++-
1 files changed, 94 insertions(+), 2 deletions(-)
diff --git a/dlls/winspool/info.c b/dlls/winspool/info.c
index 3bdd01d..a54fe32 100644
--- a/dlls/winspool/info.c
+++ b/dlls/winspool/info.c
@@ -1192,6 +1192,8 @@ DeleteMonitorW (LPWSTR pName, LPWSTR pEn
/******************************************************************
* DeletePortA [WINSPOOL.@]
*
+ * See DeletePortW.
+ *
*/
BOOL WINAPI
DeletePortA (LPSTR pName, HWND hWnd, LPSTR pPortName)
@@ -1205,6 +1207,20 @@ DeletePortA (LPSTR pName, HWND hWnd, LPS
/******************************************************************
* DeletePortW [WINSPOOL.@]
*
+ * Delete a specific Port
+ *
+ * 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 +3749,12 @@ static DWORD WINSPOOL_CountSerialPorts(v
/******************************************************************************
* EnumPortsA (WINSPOOL.@)
+ *
+ * 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 +3872,24 @@ BOOL WINAPI EnumPortsA(LPSTR name,DWORD
/******************************************************************************
* EnumPortsW (WINSPOOL.@)
+ *
+ * Enumerate available Ports
+ *
+ * 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 +4551,9 @@ BOOL WINAPI AbortPrinter( HANDLE hPrinte
/******************************************************************************
* AddPortA (WINSPOOL.@)
+ *
+ * See AddPortW.
+ *
*/
BOOL WINAPI AddPortA(LPSTR pName, HWND hWnd, LPSTR pMonitorName)
{
@@ -4520,6 +4563,21 @@ BOOL WINAPI AddPortA(LPSTR pName, HWND h
/******************************************************************************
* AddPortW (WINSPOOL.@)
+ *
+ * Add a Port for a specific Monitor
+ *
+ * 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 +4588,8 @@ BOOL WINAPI AddPortW(LPWSTR pName, HWND
/******************************************************************************
* AddPortExA (WINSPOOL.@)
*
- * Adds a print spooler port without presenting a user interface.
+ * See AddPortExW.
+ *
*/
BOOL WINAPI AddPortExA(HANDLE hMonitor, LPSTR pName, DWORD Level, LPBYTE lpBuffer, LPSTR lpMonitorName)
{
@@ -4542,7 +4601,22 @@ BOOL WINAPI AddPortExA(HANDLE hMonitor,
/******************************************************************************
* AddPortExW (WINSPOOL.@)
*
- * See AddPortExW.
+ * Add a Port for a specific Monitor, without presenting a user interface
+ *
+ * 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 +4669,9 @@ BOOL WINAPI AddPrinterDriverExA( LPSTR p
/******************************************************************************
* ConfigurePortA (WINSPOOL.@)
+ *
+ * See ConfigurePortW.
+ *
*/
BOOL WINAPI ConfigurePortA(LPSTR pName, HWND hWnd, LPSTR pPortName)
{
@@ -4604,6 +4681,21 @@ BOOL WINAPI ConfigurePortA(LPSTR pName,
/******************************************************************************
* ConfigurePortW (WINSPOOL.@)
+ *
+ * Display the Configuration-Dialog for a specific Port
+ *
+ * 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)
{
More information about the wine-cvs
mailing list