/
Registry.cpp
395 lines (344 loc) · 11.3 KB
/
Registry.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
#include "stdafx.h"
#include "registry.h"
// Keep this in sync with REGKEYNAMES
__RegKeys RegKeys[] = {
#ifdef _DEBUG
{_T("DebugTag"), regDWORD,regoptStringHex, DBGAll ,0,_T(""),_T(""),false, IDS_REGKEY_DEBUG_TAG}, // STRING_OK
#else
{_T("DebugTag"), regDWORD,regoptStringHex, DBGNoDebug ,0,_T(""),_T(""),false, IDS_REGKEY_DEBUG_TAG }, // STRING_OK
#endif
{_T("DebugToFile"), regDWORD,regoptCheck, 0 ,0,_T(""),_T(""),false, IDS_REGKEY_DEBUG_TO_FILE}, // STRING_OK
{_T("DebugFileName"), regSTRING,regoptString, 0 ,0,_T("c:\\mfcmapi.log"),_T(""),false, IDS_REGKEY_DEBUG_FILE_NAME}, // STRING_OK
{_T("ParseNamedProps"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),true, IDS_REGKEY_PARSED_NAMED_PROPS}, // STRING_OK
{_T("GetPropNamesOnAllProps"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),true, IDS_REGKEY_GETPROPNAMES_ON_ALL_PROPS}, // STRING_OK
{_T("ThrottleLevel"), regDWORD,regoptStringDec, 0 ,0,_T(""),_T(""),false, IDS_REGKEY_THROTTLE_LEVEL}, // STRING_OK
{_T("HierExpandNotifications"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),false, IDS_REGKEY_HIER_EXPAND_NOTIFS}, // STRING_OK
{_T("HierRootNotifs"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_HIER_ROOT_NOTIFS}, // STRING_OK
{_T("DoSmartView"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),true, IDS_REGKEY_DO_SMART_VIEW}, // STRING_OK
{_T("OnlyAdditionalProperties"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),true, IDS_REGKEY_ONLYADDITIONALPROPERTIES}, // STRING_OK
{_T("UseRowDataForSinglePropList"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),true, IDS_REGKEY_USE_ROW_DATA_FOR_SINGLEPROPLIST}, // STRING_OK
{_T("UseGetPropList"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),true, IDS_REGKEY_USE_GETPROPLIST}, // STRING_OK
{_T("CacheNamedProps"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),false, IDS_REGKEY_CACHE_NAMED_PROPS}, // STRING_OK
{_T("AllowDupeColumns"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_ALLOW_DUPE_COLUMNS}, // STRING_OK
{_T("DoColumnNames"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),false, IDS_REGKEY_DO_COLUMN_NAMES}, // STRING_OK
{_T("EditColumnsOnLoad"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_EDIT_COLUMNS_ON_LOAD}, // STRING_OK
{_T("ForceMDBOnline"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_MDB_ONLINE}, // STRING_OK
{_T("ForceMapiNoCache"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_MAPI_NO_CACHE}, // STRING_OK
{_T("AllowPersistCache"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_ALLOW_PERSIST_CACHE }, // STRING_OK
{_T("UseIMAPIProgress"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_USE_IMAPIPROGRESS}, // STRING_OK
{_T("UseMessageRaw"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_USE_MESSAGERAW}, // STRING_OK
{_T("SuppressNotFound"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),false, IDS_REGKEY_SUPPRESS_NOTFOUND}, // STRING_OK
{_T("HeapEnableTerminationOnCorruption"),regDWORD,regoptCheck, true ,0,_T(""),_T(""),false, IDS_REGKEY_HEAPENABLETERMINATIONONCORRUPTION}, // STRING_OK
{_T("LoadAddIns"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),false, IDS_REGKEY_LOADADDINS}, // STRING_OK
{_T("ForceOutlookMAPI"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_FORCEOUTLOOKMAPI}, // STRING_OK
{_T("ForceSystemMAPI"), regDWORD,regoptCheck, false ,0,_T(""),_T(""),false, IDS_REGKEY_FORCESYSTEMMAPI}, // STRING_OK
{_T("DisplayAboutDialog"), regDWORD,regoptCheck, true ,0,_T(""),_T(""),false, NULL}, // STRING_OK
{_T("PropertyColumnOrder"), regSTRING,regoptCheck, 0 ,0,_T(""),_T(""),false, NULL}, // STRING_OK
// {KeyName, keytype,opttype, defaultDWORD,0,defaultString,NULL,bRefresh,IDS_REGKEY_*} // Regkey template
};
void SetDefaults()
{
HRESULT hRes = S_OK;
// Set some defaults to begin with:
int i = 0;
for (i = 0 ; i < NUMRegKeys ; i++)
{
if (RegKeys[i].ulRegKeyType == regDWORD)
{
RegKeys[i].ulCurDWORD = RegKeys[i].ulDefDWORD;
}
else if (RegKeys[i].ulRegKeyType == regSTRING)
{
EC_H(StringCchCopy(
RegKeys[i].szCurSTRING,
_countof(RegKeys[i].szCurSTRING),
RegKeys[i].szDefSTRING));
}
}
} // SetDefaults
// $--HrGetRegistryValueW---------------------------------------------------------
// Get a registry value - allocating memory using new to hold it.
// -----------------------------------------------------------------------------
_Check_return_ HRESULT HrGetRegistryValueW(
_In_ HKEY hKey, // the key.
_In_z_ LPCWSTR lpszValue, // value name in key.
_Out_ DWORD* lpType, // where to put type info.
_Out_ LPVOID* lppData) // where to put the data.
{
HRESULT hRes = S_OK;
DebugPrint(DBGGeneric,_T("HrGetRegistryValue(%ws)\n"),lpszValue);
*lppData = NULL;
DWORD cb = NULL;
// Get its size
WC_W32(RegQueryValueExW(
hKey,
lpszValue,
NULL,
lpType,
NULL,
&cb));
// only handle types we know about - all others are bad
if (S_OK == hRes && cb &&
(REG_SZ == *lpType || REG_DWORD == *lpType || REG_MULTI_SZ == *lpType))
{
*lppData = new BYTE[cb];
if (*lppData)
{
// Get the current value
EC_W32(RegQueryValueExW(
hKey,
lpszValue,
NULL,
lpType,
(unsigned char*)*lppData,
&cb));
if (FAILED(hRes))
{
delete[] *lppData;
*lppData = NULL;
}
}
}
else hRes = MAPI_E_INVALID_PARAMETER;
return hRes;
} // HrGetRegistryValueW
// $--HrGetRegistryValueA---------------------------------------------------------
// Get a registry value - allocating memory using new to hold it.
// -----------------------------------------------------------------------------
_Check_return_ HRESULT HrGetRegistryValueA(
_In_ HKEY hKey, // the key.
_In_z_ LPCSTR lpszValue, // value name in key.
_Out_ DWORD* lpType, // where to put type info.
_Out_ LPVOID* lppData) // where to put the data.
{
HRESULT hRes = S_OK;
DebugPrint(DBGGeneric,_T("HrGetRegistryValueA(%hs)\n"),lpszValue);
*lppData = NULL;
DWORD cb = NULL;
// Get its size
WC_W32(RegQueryValueExA(
hKey,
lpszValue,
NULL,
lpType,
NULL,
&cb));
// only handle types we know about - all others are bad
if (S_OK == hRes && cb &&
(REG_SZ == *lpType || REG_DWORD == *lpType || REG_MULTI_SZ == *lpType))
{
*lppData = new BYTE[cb];
if (*lppData)
{
// Get the current value
EC_W32(RegQueryValueExA(
hKey,
lpszValue,
NULL,
lpType,
(unsigned char*)*lppData,
&cb));
if (FAILED(hRes))
{
delete[] *lppData;
*lppData = NULL;
}
}
}
else if (SUCCEEDED(hRes))
{
hRes = MAPI_E_INVALID_PARAMETER;
}
return hRes;
} // HrGetRegistryValueA
// If the value is not set in the registry, do not alter the passed in DWORD
void ReadDWORDFromRegistry(_In_ HKEY hKey, _In_z_ LPCTSTR szValue, _Out_ DWORD* lpdwVal)
{
HRESULT hRes = S_OK;
if (!szValue || !lpdwVal) return;
DWORD dwKeyType = NULL;
DWORD* lpValue = NULL;
WC_H(HrGetRegistryValue(
hKey,
szValue,
&dwKeyType,
(LPVOID*) &lpValue));
if (hRes == S_OK && REG_DWORD == dwKeyType && lpValue)
{
*lpdwVal = *lpValue;
}
delete[] lpValue;
} // ReadDWORDFromRegistry
// If the value is not set in the registry, do not alter the passed in string
void ReadStringFromRegistry(_In_ HKEY hKey, _In_z_ LPCTSTR szValue, _In_z_ LPTSTR szDest, ULONG cchDestLen)
{
HRESULT hRes = S_OK;
if (!szValue || !szDest || (cchDestLen < 1)) return;
DWORD dwKeyType = NULL;
LPTSTR szBuf = NULL;
WC_H(HrGetRegistryValue(
hKey,
szValue,
&dwKeyType,
(LPVOID*) &szBuf));
if (hRes == S_OK && REG_SZ == dwKeyType && szBuf)
{
WC_H(StringCchCopy(szDest,cchDestLen,szBuf));
}
delete[] szBuf;
} // ReadStringFromRegistry
void ReadFromRegistry()
{
HRESULT hRes = S_OK;
HKEY hRootKey = NULL;
WC_W32(RegOpenKeyEx(
HKEY_CURRENT_USER,
RKEY_ROOT,
NULL,
KEY_READ,
&hRootKey));
// Now that we have a root key, go get our values
if (hRootKey)
{
int i = 0;
for (i = 0 ; i < NUMRegKeys ; i++)
{
if (RegKeys[i].ulRegKeyType == regDWORD)
{
ReadDWORDFromRegistry(
hRootKey,
RegKeys[i].szKeyName,
&RegKeys[i].ulCurDWORD);
}
else if (RegKeys[i].ulRegKeyType == regSTRING)
{
ReadStringFromRegistry(
hRootKey,
RegKeys[i].szKeyName,
RegKeys[i].szCurSTRING,
_countof(RegKeys[i].szCurSTRING));
if (RegKeys[i].szCurSTRING[0] == _T('\0'))
{
EC_H(StringCchCopy(
RegKeys[i].szCurSTRING,
_countof(RegKeys[i].szCurSTRING),
RegKeys[i].szDefSTRING));
}
}
}
EC_W32(RegCloseKey(hRootKey));
}
SetDebugLevel(RegKeys[regkeyDEBUG_TAG].ulCurDWORD);
DebugPrintVersion(DBGVersionBanner);
} // ReadFromRegistry
void WriteDWORDToRegistry(_In_ HKEY hKey, _In_z_ LPCTSTR szValueName, DWORD dwValue)
{
HRESULT hRes = S_OK;
WC_W32(RegSetValueEx(
hKey,
szValueName,
NULL,
REG_DWORD,
(LPBYTE) &dwValue,
sizeof(DWORD)));
} // WriteDWORDToRegistry
void CommitDWORDIfNeeded(_In_ HKEY hKey, _In_z_ LPCTSTR szValueName, DWORD dwValue, DWORD dwDefaultValue)
{
HRESULT hRes = S_OK;
if (dwValue != dwDefaultValue)
{
WriteDWORDToRegistry(
hKey,
szValueName,
dwValue);
}
else
{
WC_W32(RegDeleteValue(hKey,szValueName));
hRes = S_OK;
}
} // CommitDWORDIfNeeded
void WriteStringToRegistry(_In_ HKEY hKey, _In_z_ LPCTSTR szValueName, _In_z_ LPCTSTR szValue)
{
HRESULT hRes = S_OK;
size_t cbValue = 0;
// Reg needs bytes, so CB is correct here
EC_H(StringCbLength(szValue,STRSAFE_MAX_CCH * sizeof(TCHAR),&cbValue));
cbValue += sizeof(TCHAR); // NULL terminator
WC_W32(RegSetValueEx(
hKey,
szValueName,
NULL,
REG_SZ,
(LPBYTE) szValue,
(DWORD) cbValue));
} // WriteStringToRegistry
void CommitStringIfNeeded(_In_ HKEY hKey, _In_z_ LPCTSTR szValueName, _In_z_ LPCTSTR szValue, _In_z_ LPCTSTR szDefaultValue)
{
HRESULT hRes = S_OK;
if (0 != lstrcmpi(szValue,szDefaultValue))
{
WriteStringToRegistry(
hKey,
szValueName,
szValue);
}
else
{
WC_W32(RegDeleteValue(hKey,szValueName));
hRes = S_OK;
}
} // CommitStringIfNeeded
_Check_return_ HKEY CreateRootKey()
{
HRESULT hRes = S_OK;
HKEY hkSub = NULL;
// Try to open the root key before we do the work to create it
WC_W32(RegOpenKeyEx(
HKEY_CURRENT_USER,
RKEY_ROOT,
NULL,
KEY_READ | KEY_WRITE,
&hkSub));
if (SUCCEEDED(hRes) && hkSub) return hkSub;
hRes = S_OK;
WC_W32(RegCreateKeyEx(
HKEY_CURRENT_USER,
RKEY_ROOT,
0,
NULL,
0,
KEY_READ | KEY_WRITE,
NULL,
&hkSub,
NULL));
return hkSub;
} // CreateRootKey
void WriteToRegistry()
{
HRESULT hRes = S_OK;
HKEY hRootKey = NULL;
hRootKey = CreateRootKey();
// Now that we have a root key, go set our values
int i = 0;
for (i = 0 ; i < NUMRegKeys ; i++)
{
if (RegKeys[i].ulRegKeyType == regDWORD)
{
CommitDWORDIfNeeded(
hRootKey,
RegKeys[i].szKeyName,
RegKeys[i].ulCurDWORD,
RegKeys[i].ulDefDWORD);
}
else if (RegKeys[i].ulRegKeyType == regSTRING)
{
CommitStringIfNeeded(
hRootKey,
RegKeys[i].szKeyName,
RegKeys[i].szCurSTRING,
RegKeys[i].szDefSTRING);
}
}
if (hRootKey) EC_W32(RegCloseKey(hRootKey));
} // WriteToRegistry