Merge pull request #1 from Microsoft/master

Updating Local

1 files changed, 214 insertions, 0 deletions

diff --git a/print/OEM Printer Customization Plug-in Samples/C++/SyncSet/devmode.cpp b/print/OEM Printer Customization Plug-in Samples/C++/SyncSet/devmode.cpp
new file mode 100644
index 00000000..2a19310c
--- /dev/null
+++ b/print/OEM Printer Customization Plug-in Samples/C++/SyncSet/devmode.cpp
@@ -0,0 +1,214 @@
+//  THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
+//  ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
+//  PARTICULAR PURPOSE.
+//
+//  Copyright  1998 - 2003  Microsoft Corporation.  All Rights Reserved.
+//
+//  FILE:    Devmode.cpp
+//    
+//
+//  PURPOSE:  Implementation of Devmode functions shared with OEM UI and OEM rendering modules.
+//
+
+#include "precomp.h"
+#include "oemui.h"
+#include "debug.h"
+#include "devmode.h"
+
+// This indicates to Prefast that this is a usermode driver file.
+_Analysis_mode_(_Analysis_code_type_user_driver_);
+
+
+//
+//Performs operation on UI Plugins Private DevMode Members.
+//Called via IOemUI::DevMode
+//
+
+HRESULT hrOEMDevMode(DWORD dwMode, POEMDMPARAM pOemDMParam)
+{
+    POEMDEV pOEMDevIn;
+    POEMDEV pOEMDevOut;
+
+
+    // Verify parameters.
+    if( (NULL == pOemDMParam)
+        ||
+        ( (OEMDM_SIZE != dwMode)
+          &&
+          (OEMDM_DEFAULT != dwMode)
+          &&
+          (OEMDM_CONVERT != dwMode)
+          &&
+          (OEMDM_MERGE != dwMode)
+        )
+      )
+    {
+        ERR(ERRORTEXT("DevMode() ERROR_INVALID_PARAMETER.\r\n"));
+        VERBOSE(DLLTEXT("\tdwMode = %d, pOemDMParam = %#lx.\r\n"), dwMode, pOemDMParam);
+
+        SetLastError(ERROR_INVALID_PARAMETER);
+        return E_FAIL;
+    }
+
+    // Cast generic (i.e. PVOID) to OEM private devomode pointer type.
+    pOEMDevIn = (POEMDEV) pOemDMParam->pOEMDMIn;
+    pOEMDevOut = (POEMDEV) pOemDMParam->pOEMDMOut;
+
+    switch(dwMode)
+    {
+		//
+		//The Method should return the size of the memory allocation needed to store the UI plugin Private DEVMODE.
+		//
+        case OEMDM_SIZE:
+            pOemDMParam->cbBufSize = sizeof(OEMDEV);
+            break;
+
+		//
+		//Should fill the Private DEVMODE with the default values.
+		//
+        case OEMDM_DEFAULT:
+			//
+			//OEM_DMEXTRAHEADER Members
+			//
+            pOEMDevOut->dmOEMExtra.dwSize       = sizeof(OEMDEV);
+            pOEMDevOut->dmOEMExtra.dwSignature  = OEM_SIGNATURE;
+            pOEMDevOut->dmOEMExtra.dwVersion    = OEM_VERSION;
+
+			//
+			//Private members
+			//
+            pOEMDevOut->dwDriverData            = 0;
+            pOEMDevOut->dwAdvancedData          = 0;
+
+            VERBOSE(DLLTEXT("pOEMDevOut after setting default values:\r\n"));
+            Dump(pOEMDevOut);			
+            break;
+			
+		//
+		//The method should convert private DEVMODE members to the current version, if necessary.
+		//
+        case OEMDM_CONVERT:
+            ConvertOEMDevmode(pOEMDevIn, pOEMDevOut);
+            break;
+		
+		//
+		//The method should validate the information contained in private DEVMODE members and merge validated values into a private DEVMODE structure containing default values
+		//
+        case OEMDM_MERGE:
+            ConvertOEMDevmode(pOEMDevIn, pOEMDevOut);
+            MakeOEMDevmodeValid(pOEMDevOut);
+            break;
+    }
+    Dump(pOemDMParam);
+
+    return S_OK;
+}
+
+
+BOOL ConvertOEMDevmode(PCOEMDEV pOEMDevIn, POEMDEV pOEMDevOut)
+{
+    if( (NULL == pOEMDevIn)
+        ||
+        (NULL == pOEMDevOut)
+      )
+    {
+        ERR(ERRORTEXT("ConvertOEMDevmode() invalid parameters.\r\n"));
+        return FALSE;
+    }
+
+    // Check OEM Signature, if it doesn't match ours,
+    // then just assume DMIn is bad and use defaults.
+    if(pOEMDevIn->dmOEMExtra.dwSignature == pOEMDevOut->dmOEMExtra.dwSignature)
+    {
+        VERBOSE(DLLTEXT("Converting private OEM Devmode.\r\n"));
+        VERBOSE(DLLTEXT("pOEMDevIn:\r\n"));
+        Dump(pOEMDevIn);
+
+        // Set the devmode defaults so that anything the isn't copied over will
+        // be set to the default value.
+        pOEMDevOut->dwDriverData    = 0;
+        pOEMDevOut->dwAdvancedData  = 0;
+
+        // Copy the old structure in to the new using which ever size is the smaller.
+        // Devmode maybe from newer Devmode (not likely since there is only one), or
+        // Devmode maybe a newer Devmode, in which case it maybe larger,
+        // but the first part of the structure should be the same.
+
+        // DESIGN ASSUMPTION: the private DEVMODE structure only gets added to;
+        // the fields that are in the DEVMODE never change only new fields get added to the end.
+
+        memcpy(pOEMDevOut, pOEMDevIn, __min(pOEMDevOut->dmOEMExtra.dwSize, pOEMDevIn->dmOEMExtra.dwSize));
+
+        // Re-fill in the size and version fields to indicated 
+        // that the DEVMODE is the current private DEVMODE version.
+        pOEMDevOut->dmOEMExtra.dwSize       = sizeof(OEMDEV);
+        pOEMDevOut->dmOEMExtra.dwVersion    = OEM_VERSION;
+    }
+    else
+    {
+        WARNING(DLLTEXT("Unknown DEVMODE signature, pOEMDMIn ignored.\r\n"));
+
+        // Don't know what the input DEVMODE is, so just use defaults.
+        pOEMDevOut->dmOEMExtra.dwSize       = sizeof(OEMDEV);
+        pOEMDevOut->dmOEMExtra.dwSignature  = OEM_SIGNATURE;
+        pOEMDevOut->dmOEMExtra.dwVersion    = OEM_VERSION;
+        pOEMDevOut->dwDriverData            = 0;
+        pOEMDevOut->dwAdvancedData          = 0;
+    }
+
+    return TRUE;
+}
+
+
+BOOL MakeOEMDevmodeValid(POEMDEV pOEMDevmode)
+{
+    if(NULL == pOEMDevmode)
+    {
+        return FALSE;
+    }
+
+    // ASSUMPTION: pOEMDevmode is large enough to contain OEMDEV structure.
+
+    // Make sure that dmOEMExtra indicates the current OEMDEV structure.
+    pOEMDevmode->dmOEMExtra.dwSize       = sizeof(OEMDEV);
+    pOEMDevmode->dmOEMExtra.dwSignature  = OEM_SIGNATURE;
+    pOEMDevmode->dmOEMExtra.dwVersion    = OEM_VERSION;
+
+    // Set driver data, if not valid.
+    if(pOEMDevmode->dwDriverData > 100)
+    {
+        pOEMDevmode->dwDriverData = 0;
+    }
+
+    // Set Advanced driver data, if not valid.
+    if(pOEMDevmode->dwAdvancedData > 100)
+    {
+        pOEMDevmode->dwAdvancedData = 0;
+    }
+
+    return TRUE;
+}
+
+
+void Dump(PCOEMDEV pOEMDevmode)
+{
+    if( (NULL != pOEMDevmode)
+        &&
+        (pOEMDevmode->dmOEMExtra.dwSize >= sizeof(OEMDEV))
+        &&
+        (OEM_SIGNATURE == pOEMDevmode->dmOEMExtra.dwSignature)
+      )
+    {
+        VERBOSE(TEXT("\tdmOEMExtra.dwSize      = %d\r\n"), pOEMDevmode->dmOEMExtra.dwSize);
+        VERBOSE(TEXT("\tdmOEMExtra.dwSignature = %#x\r\n"), pOEMDevmode->dmOEMExtra.dwSignature);
+        VERBOSE(TEXT("\tdmOEMExtra.dwVersion   = %#x\r\n"), pOEMDevmode->dmOEMExtra.dwVersion);
+        VERBOSE(TEXT("\tdwDriverData           = %#x\r\n"), pOEMDevmode->dwDriverData);
+        VERBOSE(TEXT("\tdwAdvancedData         = %#x\r\n"), pOEMDevmode->dwAdvancedData);
+    }
+    else
+    {
+        ERR(ERRORTEXT("Dump(POEMDEV) unknown private OEM DEVMODE.\r\n"));
+    }
+}
+