Use CompareStringOrdinal() instead of CompareString() case-sensitive

This commit moves to the modern CompareStringOrdinal() for all case-sensitve
uses of CompareString() with the invariant locale.

Resolves 6947

Author: robmen

src/api/burn/balutil/balinfo.cpp

@@ -190,7 +190,7 @@ DAPI_(HRESULT) BalInfoAddRelatedBundleAsPackage(
     // Check to see if the bundle is already in the list of packages.
     for (DWORD i = 0; i < pPackages->cPackages; ++i)
     {
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, wzId, -1, pPackages->rgPackages[i].sczId, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(wzId, -1, pPackages->rgPackages[i].sczId, -1, FALSE))
         {
             ExitFunction1(hr = HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS));
         }
@@ -232,7 +232,7 @@ DAPI_(HRESULT) BalInfoAddUpdateBundleAsPackage(
     // Check to see if the bundle is already in the list of packages.
     for (DWORD i = 0; i < pPackages->cPackages; ++i)
     {
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, wzId, -1, pPackages->rgPackages[i].sczId, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(wzId, -1, pPackages->rgPackages[i].sczId, -1, FALSE))
         {
             ExitFunction1(hr = HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS));
         }
@@ -270,7 +270,7 @@ DAPI_(HRESULT) BalInfoFindPackageById(
 
     for (DWORD i = 0; i < pPackages->cPackages; ++i)
     {
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, wzId, -1, pPackages->rgPackages[i].sczId, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(wzId, -1, pPackages->rgPackages[i].sczId, -1, FALSE))
         {
             *ppPackage = pPackages->rgPackages + i;
             break;
@@ -409,23 +409,23 @@ static HRESULT ParsePackagesFromXml(
         hr = XmlGetAttributeEx(pNode, L"PackageType", &scz);
         ExitOnRequiredXmlQueryFailure(hr, "Failed to get package type for package.");
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, L"Bundle", -1, scz, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(L"Bundle", -1, scz, -1, FALSE))
         {
             prgPackages[iPackage].type = BAL_INFO_PACKAGE_TYPE_BUNDLE_CHAIN;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, L"Exe", -1, scz, -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(L"Exe", -1, scz, -1, FALSE))
         {
             prgPackages[iPackage].type = BAL_INFO_PACKAGE_TYPE_EXE;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, L"Msi", -1, scz, -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(L"Msi", -1, scz, -1, FALSE))
         {
             prgPackages[iPackage].type = BAL_INFO_PACKAGE_TYPE_MSI;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, L"Msp", -1, scz, -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(L"Msp", -1, scz, -1, FALSE))
         {
             prgPackages[iPackage].type = BAL_INFO_PACKAGE_TYPE_MSP;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, L"Msu", -1, scz, -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(L"Msu", -1, scz, -1, FALSE))
         {
             prgPackages[iPackage].type = BAL_INFO_PACKAGE_TYPE_MSU;
         }
@@ -454,15 +454,15 @@ static HRESULT ParsePackagesFromXml(
         hr = XmlGetAttributeEx(pNode, L"Cache", &scz);
         ExitOnRequiredXmlQueryFailure(hr, "Failed to get cache type for package.");
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, scz, -1, L"remove", -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"remove", -1, FALSE))
         {
             prgPackages[iPackage].cacheType = BOOTSTRAPPER_CACHE_TYPE_REMOVE;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, scz, -1, L"keep", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"keep", -1, FALSE))
         {
             prgPackages[iPackage].cacheType = BOOTSTRAPPER_CACHE_TYPE_KEEP;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, scz, -1, L"force", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"force", -1, FALSE))
         {
             prgPackages[iPackage].cacheType = BOOTSTRAPPER_CACHE_TYPE_FORCE;
         }
@@ -522,19 +522,19 @@ static HRESULT ParseBalPackageInfoFromXml(
 
         if (fXmlFound)
         {
-            if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"default", -1))
+            if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"default", -1, FALSE))
             {
                 pPackage->primaryPackageType = BAL_INFO_PRIMARY_PACKAGE_TYPE_DEFAULT;
             }
-            else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"x86", -1))
+            else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"x86", -1, FALSE))
             {
                 pPackage->primaryPackageType = BAL_INFO_PRIMARY_PACKAGE_TYPE_X86;
             }
-            else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"x64", -1))
+            else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"x64", -1, FALSE))
             {
                 pPackage->primaryPackageType = BAL_INFO_PRIMARY_PACKAGE_TYPE_X64;
             }
-            else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"arm64", -1))
+            else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"arm64", -1, FALSE))
             {
                 pPackage->primaryPackageType = BAL_INFO_PRIMARY_PACKAGE_TYPE_ARM64;
             }
@@ -611,11 +611,11 @@ static HRESULT ParseOverridableVariablesFromXml(
         hr = XmlGetAttributeEx(pCommandLineNode, L"VariableType", &scz);
         ExitOnRequiredXmlQueryFailure(hr, "Failed to get command line variable type.");
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"caseInsensitive", -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"caseInsensitive", -1, FALSE))
         {
             pOverridableVariables->commandLineType = BAL_INFO_VARIABLE_COMMAND_LINE_TYPE_CASE_INSENSITIVE;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"caseSensitive", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"caseSensitive", -1, FALSE))
         {
             pOverridableVariables->commandLineType = BAL_INFO_VARIABLE_COMMAND_LINE_TYPE_CASE_SENSITIVE;
         }

src/api/burn/balutil/balretry.cpp

@@ -211,7 +211,7 @@ static BOOL IsActiveRetryEntry(
 {
     BOOL fActive = FALSE;
 
-    fActive = vrgRetryInfo[type].sczId && CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, sczId, -1, vrgRetryInfo[type].sczId, -1);
+    fActive = vrgRetryInfo[type].sczId && CSTR_EQUAL == ::CompareStringOrdinal(sczId, -1, vrgRetryInfo[type].sczId, -1, FALSE);
 
     return fActive;
 }

src/api/burn/bextutil/bextutil.cpp

@@ -87,7 +87,7 @@ DAPI_(HRESULT) BextGetBootstrapperExtensionDataNode(
         hr = XmlGetAttributeEx(pixnNode, L"Id", &sczId);
         ExitOnRequiredXmlQueryFailure(hr, "Failed to get @Id.");
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, sczId, -1, wzExtensionId, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(sczId, -1, wzExtensionId, -1, FALSE))
         {
             *ppixnBootstrapperExtension = pixnNode;
             pixnNode = NULL;

src/burn/engine/approvedexe.cpp

@@ -129,7 +129,7 @@ extern "C" HRESULT ApprovedExesFindById(
     {
         pApprovedExe = &pApprovedExes->rgApprovedExes[i];
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, pApprovedExe->sczId, -1, wzId, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(pApprovedExe->sczId, -1, wzId, -1, FALSE))
         {
             *ppApprovedExe = pApprovedExe;
             ExitFunction1(hr = S_OK);

src/burn/engine/bundlepackageengine.cpp

@@ -146,7 +146,7 @@ extern "C" HRESULT BundlePackageEngineParseRelatedCodes(
         hr = XmlGetAttributeEx(pixnElement, L"Code", &sczCode);
         ExitOnFailure(hr, "Failed to get @Code.");
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, sczAction, -1, L"Detect", -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(sczAction, -1, L"Detect", -1, FALSE))
         {
             hr = MemEnsureArraySizeForNewItems(reinterpret_cast<LPVOID*>(prgsczDetectCodes), *pcDetectCodes, 1, sizeof(LPWSTR), 5);
             ExitOnFailure(hr, "Failed to resize Detect code array");
@@ -155,7 +155,7 @@ extern "C" HRESULT BundlePackageEngineParseRelatedCodes(
             sczCode = NULL;
             *pcDetectCodes += 1;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, sczAction, -1, L"Upgrade", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(sczAction, -1, L"Upgrade", -1, FALSE))
         {
             hr = MemEnsureArraySizeForNewItems(reinterpret_cast<LPVOID*>(prgsczUpgradeCodes), *pcUpgradeCodes, 1, sizeof(LPWSTR), 5);
             ExitOnFailure(hr, "Failed to resize Upgrade code array");
@@ -164,7 +164,7 @@ extern "C" HRESULT BundlePackageEngineParseRelatedCodes(
             sczCode = NULL;
             *pcUpgradeCodes += 1;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, sczAction, -1, L"Addon", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(sczAction, -1, L"Addon", -1, FALSE))
         {
             hr = MemEnsureArraySizeForNewItems(reinterpret_cast<LPVOID*>(prgsczAddonCodes), *pcAddonCodes, 1, sizeof(LPWSTR), 5);
             ExitOnFailure(hr, "Failed to resize Addon code array");
@@ -173,7 +173,7 @@ extern "C" HRESULT BundlePackageEngineParseRelatedCodes(
             sczCode = NULL;
             *pcAddonCodes += 1;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, sczAction, -1, L"Patch", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(sczAction, -1, L"Patch", -1, FALSE))
         {
             hr = MemEnsureArraySizeForNewItems(reinterpret_cast<LPVOID*>(prgsczPatchCodes), *pcPatchCodes, 1, sizeof(LPWSTR), 5);
             ExitOnFailure(hr, "Failed to resize Patch code array");

src/burn/engine/burnextension.cpp

@@ -214,7 +214,7 @@ EXTERN_C HRESULT BurnExtensionFindById(
     {
         pExtension = &pBurnExtensions->rgExtensions[i];
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, pExtension->sczId, -1, wzId, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(pExtension->sczId, -1, wzId, -1, FALSE))
         {
             *ppExtension = pExtension;
             ExitFunction1(hr = S_OK);

src/burn/engine/burnpipe.cpp

@@ -515,7 +515,7 @@ static HRESULT ChildPipeConnected(
     ExitOnFailure(hr, "Failed to read verification secret from parent pipe.");
 
     // Verify the secrets match.
-    if (CSTR_EQUAL != ::CompareStringW(LOCALE_NEUTRAL, 0, sczVerificationSecret, -1, wzSecret, -1))
+    if (CSTR_EQUAL != ::CompareStringOrdinal(sczVerificationSecret, -1, wzSecret, -1, FALSE))
     {
         hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
         ExitOnRootFailure(hr, "Verification secret from parent does not match.");

src/burn/engine/condition.cpp

@@ -928,7 +928,7 @@ static HRESULT CompareStringValues(
     )
 {
     HRESULT hr = S_OK;
-    DWORD dwCompareString = (comparison & INSENSITIVE) ? NORM_IGNORECASE : 0;
+    BOOL fIgnoreCase = (comparison & INSENSITIVE) ? TRUE : FALSE;
     size_t cchLeftSize = 0;
     size_t cchRightSize = 0;
     int cchLeft = 0;
@@ -958,7 +958,7 @@ static HRESULT CompareStringValues(
     case BURN_SYMBOL_TYPE_EQ_I:
     case BURN_SYMBOL_TYPE_NE_I:
         {
-            int i = ::CompareStringW(LOCALE_INVARIANT, dwCompareString, wzLeftOperand, cchLeft, wzRightOperand, cchRight);
+            int i = ::CompareStringOrdinal(wzLeftOperand, cchLeft, wzRightOperand, cchRight, fIgnoreCase);
             hr = CompareIntegerValues(comparison, i, CSTR_EQUAL, pfResult);
         }
         break;
@@ -967,7 +967,7 @@ static HRESULT CompareStringValues(
         // test if left string contains right string
         for (int i = 0; (i + cchRight) <= cchLeft; ++i)
         {
-            if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, dwCompareString, wzLeftOperand + i, cchRight, wzRightOperand, cchRight))
+            if (CSTR_EQUAL == ::CompareStringOrdinal(wzLeftOperand + i, cchRight, wzRightOperand, cchRight, fIgnoreCase))
             {
                 *pfResult = TRUE;
                 ExitFunction();
@@ -978,12 +978,12 @@ static HRESULT CompareStringValues(
     case BURN_SYMBOL_TYPE_HIEQ:
     case BURN_SYMBOL_TYPE_HIEQ_I:
         // test if left string starts with right string
-        *pfResult = cchLeft >= cchRight && CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, dwCompareString, wzLeftOperand, cchRight, wzRightOperand, cchRight);
+        *pfResult = cchLeft >= cchRight && CSTR_EQUAL == ::CompareStringOrdinal(wzLeftOperand, cchRight, wzRightOperand, cchRight, fIgnoreCase);
         break;
     case BURN_SYMBOL_TYPE_LOEQ:
     case BURN_SYMBOL_TYPE_LOEQ_I:
         // test if left string ends with right string
-        *pfResult = cchLeft >= cchRight && CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, dwCompareString, wzLeftOperand + (cchLeft - cchRight), cchRight, wzRightOperand, cchRight);
+        *pfResult = cchLeft >= cchRight && CSTR_EQUAL == ::CompareStringOrdinal(wzLeftOperand + (cchLeft - cchRight), cchRight, wzRightOperand, cchRight, fIgnoreCase);
         break;
     default:
         ExitFunction1(hr = E_INVALIDARG);

src/burn/engine/container.cpp

@@ -400,7 +400,7 @@ extern "C" HRESULT ContainerFindById(
     {
         pContainer = &pContainers->rgContainers[i];
 
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, pContainer->sczId, -1, wzId, -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(pContainer->sczId, -1, wzId, -1, FALSE))
         {
             *ppContainer = pContainer;
             ExitFunction1(hr = S_OK);

src/burn/engine/exeengine.cpp

@@ -25,15 +25,15 @@ extern "C" HRESULT ExeEngineParsePackageFromXml(
     hr = XmlGetAttributeEx(pixnExePackage, L"DetectionType", &scz);
     ExitOnRequiredXmlQueryFailure(hr, "Failed to get @DetectionType.");
 
-    if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"condition", -1))
+    if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"condition", -1, FALSE))
     {
         pPackage->Exe.detectionType = BURN_EXE_DETECTION_TYPE_CONDITION;
     }
-    else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"arp", -1))
+    else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"arp", -1, FALSE))
     {
         pPackage->Exe.detectionType = BURN_EXE_DETECTION_TYPE_ARP;
     }
-    else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"none", -1))
+    else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"none", -1, FALSE))
     {
         pPackage->Exe.detectionType = BURN_EXE_DETECTION_TYPE_NONE;
     }
@@ -114,15 +114,15 @@ extern "C" HRESULT ExeEngineParsePackageFromXml(
 
     if (fFoundXml)
     {
-        if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"burn", -1))
+        if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"burn", -1, FALSE))
         {
             pPackage->Exe.protocol = BURN_EXE_PROTOCOL_TYPE_BURN;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"netfx4", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"netfx4", -1, FALSE))
         {
             pPackage->Exe.protocol = BURN_EXE_PROTOCOL_TYPE_NETFX4;
         }
-        else if (CSTR_EQUAL == ::CompareStringW(LOCALE_INVARIANT, 0, scz, -1, L"none", -1))
+        else if (CSTR_EQUAL == ::CompareStringOrdinal(scz, -1, L"none", -1, FALSE))
         {
             pPackage->Exe.protocol = BURN_EXE_PROTOCOL_TYPE_NONE;
         }