Bug 1265739 - DocumenetProperties should use LONG as return type. r=jimm

When investigating bug 1075194, I found that we don't check return value of DocumentPropertiesW.  So we sould use correct type and add log for this API.

MozReview-Commit-ID: Ck3VwMq9OpQ

--HG--
extra : amend_source : a0da15b578055b7612ce96b44cac2cd69607fa51

embedding/components/printingui/win/nsPrintDialogUtil.cpp

@@ -481,28 +481,28 @@ CreateGlobalDevModeAndInit(const nsXPIDLString& aPrintName,
   nsAutoPrinter autoPrinter(hPrinter);
 
   // Get the buffer size
-  DWORD dwNeeded = ::DocumentPropertiesW(gParentWnd, hPrinter, printName, nullptr,
-                                         nullptr, 0);
-  if (dwNeeded == 0) {
+  LONG needed = ::DocumentPropertiesW(gParentWnd, hPrinter, printName, nullptr,
+                                      nullptr, 0);
+  if (needed < 0) {
     return nsReturnRef<nsHGLOBAL>();
   }
 
   // Allocate a buffer of the correct size.
   nsAutoDevMode newDevMode((LPDEVMODEW)::HeapAlloc(::GetProcessHeap(), HEAP_ZERO_MEMORY,
-                                                   dwNeeded));
+                                                   needed));
   if (!newDevMode) {
     return nsReturnRef<nsHGLOBAL>();
   }
 
-  nsHGLOBAL hDevMode = ::GlobalAlloc(GHND, dwNeeded);
+  nsHGLOBAL hDevMode = ::GlobalAlloc(GHND, needed);
   nsAutoGlobalMem globalDevMode(hDevMode);
   if (!hDevMode) {
     return nsReturnRef<nsHGLOBAL>();
   }
 
-  DWORD dwRet = ::DocumentPropertiesW(gParentWnd, hPrinter, printName, newDevMode,
-                                      nullptr, DM_OUT_BUFFER);
-  if (dwRet != IDOK) {
+  LONG ret = ::DocumentPropertiesW(gParentWnd, hPrinter, printName, newDevMode,
+                                   nullptr, DM_OUT_BUFFER);
+  if (ret != IDOK) {
     return nsReturnRef<nsHGLOBAL>();
   }
 
@@ -513,16 +513,16 @@ CreateGlobalDevModeAndInit(const nsXPIDLString& aPrintName,
     return nsReturnRef<nsHGLOBAL>();
   }
 
-  memcpy(devMode, newDevMode.get(), dwNeeded);
+  memcpy(devMode, newDevMode.get(), needed);
   // Initialize values from the PrintSettings
   nsCOMPtr<nsIPrintSettingsWin> psWin = do_QueryInterface(aPS);
   MOZ_ASSERT(psWin);
   psWin->CopyToNative(devMode);
 
   // Sets back the changes we made to the DevMode into the Printer Driver
-  dwRet = ::DocumentPropertiesW(gParentWnd, hPrinter, printName, devMode, devMode,
-                                DM_IN_BUFFER | DM_OUT_BUFFER);
-  if (dwRet != IDOK) {
+  ret = ::DocumentPropertiesW(gParentWnd, hPrinter, printName, devMode, devMode,
+                              DM_IN_BUFFER | DM_OUT_BUFFER);
+  if (ret != IDOK) {
     ::GlobalUnlock(hDevMode);
     return nsReturnRef<nsHGLOBAL>();
   }

widget/windows/nsDeviceContextSpecWin.cpp

@@ -13,15 +13,12 @@
 
 #include <winspool.h>
 
-#include <tchar.h>
-
 #include "nsIWidget.h"
 
 #include "nsTArray.h"
 #include "nsIPrintSettingsWin.h"
 
 #include "nsString.h"
-#include "nsCRT.h"
 #include "nsIServiceManager.h"
 #include "nsReadableUtils.h"
 #include "nsStringEnumerator.h"
@@ -34,15 +31,6 @@
 #include "mozilla/Services.h"
 #include "nsWindowsHelpers.h"
 
-// For NS_CopyNativeToUnicode
-#include "nsNativeCharsetUtils.h"
-
-// File Picker
-#include "nsIFile.h"
-#include "nsIFilePicker.h"
-#include "nsIStringBundle.h"
-#define NS_ERROR_GFX_PRINTER_BUNDLE_URL "chrome://global/locale/printing.properties"
-
 #include "mozilla/gfx/Logging.h"
 
 #include "mozilla/Logging.h"
@@ -342,42 +330,50 @@ nsDeviceContextSpecWin::GetDataFromPrinter(char16ptr_t aName, nsIPrintSettings*
     NS_ENSURE_SUCCESS(rv, rv);
   }
 
-  HANDLE hPrinter = nullptr;
+  nsHPRINTER hPrinter = nullptr;
   wchar_t *name = (wchar_t*)aName; // Windows APIs use non-const name argument
 
   BOOL status = ::OpenPrinterW(name, &hPrinter, nullptr);
   if (status) {
+    nsAutoPrinter autoPrinter(hPrinter);
 
     LPDEVMODEW   pDevMode;
-    DWORD       dwNeeded, dwRet;
 
     // Allocate a buffer of the correct size.
-    dwNeeded = ::DocumentPropertiesW(nullptr, hPrinter, name, nullptr, nullptr, 0);
+    LONG needed = ::DocumentPropertiesW(nullptr, hPrinter, name, nullptr,
+                                        nullptr, 0);
+    if (needed < 0) {
+      PR_PL(("**** nsDeviceContextSpecWin::GetDataFromPrinter - Couldn't get "
+             "size of DEVMODE using DocumentPropertiesW(pDeviceName = \"%s\"). "
+             "GetLastEror() = %08x\n",
+             aName ? NS_ConvertUTF16toUTF8(aName).get() : "", GetLastError()));
+      return NS_ERROR_FAILURE;
+    }
 
-    pDevMode = (LPDEVMODEW)::HeapAlloc (::GetProcessHeap(), HEAP_ZERO_MEMORY, dwNeeded);
+    pDevMode = (LPDEVMODEW)::HeapAlloc(::GetProcessHeap(), HEAP_ZERO_MEMORY,
+                                       needed);
     if (!pDevMode) return NS_ERROR_FAILURE;
 
     // Get the default DevMode for the printer and modify it for our needs.
-    dwRet = DocumentPropertiesW(nullptr, hPrinter, name,
-                               pDevMode, nullptr, DM_OUT_BUFFER);
+    LONG ret = ::DocumentPropertiesW(nullptr, hPrinter, name,
+                                     pDevMode, nullptr, DM_OUT_BUFFER);
 
-    if (dwRet == IDOK && aPS) {
+    if (ret == IDOK && aPS) {
       nsCOMPtr<nsIPrintSettingsWin> psWin = do_QueryInterface(aPS);
       MOZ_ASSERT(psWin);
       psWin->CopyToNative(pDevMode);
       // Sets back the changes we made to the DevMode into the Printer Driver
-      dwRet = ::DocumentPropertiesW(nullptr, hPrinter, name,
-                                   pDevMode, pDevMode,
-                                   DM_IN_BUFFER | DM_OUT_BUFFER);
+      ret = ::DocumentPropertiesW(nullptr, hPrinter, name,
+                                  pDevMode, pDevMode,
+                                  DM_IN_BUFFER | DM_OUT_BUFFER);
 
       // We need to copy the final DEVMODE settings back to our print settings,
       // because they may have been set from invalid prefs.
-      if (dwRet == IDOK) {
+      if (ret == IDOK) {
         // We need to get information from the device as well.
         nsAutoHDC printerDC(::CreateICW(kDriverName, aName, nullptr, pDevMode));
         if (NS_WARN_IF(!printerDC)) {
           ::HeapFree(::GetProcessHeap(), 0, pDevMode);
-          ::ClosePrinter(hPrinter);
           return NS_ERROR_FAILURE;
         }
 
@@ -385,10 +381,9 @@ nsDeviceContextSpecWin::GetDataFromPrinter(char16ptr_t aName, nsIPrintSettings*
       }
     }
 
-    if (dwRet != IDOK) {
+    if (ret != IDOK) {
       ::HeapFree(::GetProcessHeap(), 0, pDevMode);
-      ::ClosePrinter(hPrinter);
-      PR_PL(("***** nsDeviceContextSpecWin::GetDataFromPrinter - DocumentProperties call failed code: %d/0x%x\n", dwRet, dwRet));
+      PR_PL(("***** nsDeviceContextSpecWin::GetDataFromPrinter - DocumentProperties call failed code: %d/0x%x\n", ret, ret));
       DISPLAY_LAST_ERROR
       return NS_ERROR_FAILURE;
     }
@@ -399,7 +394,6 @@ nsDeviceContextSpecWin::GetDataFromPrinter(char16ptr_t aName, nsIPrintSettings*
 
     SetDriverName(kDriverName);
 
-    ::ClosePrinter(hPrinter);
     rv = NS_OK;
   } else {
     rv = NS_ERROR_GFX_PRINTER_NAME_NOT_FOUND;