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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
namespace WixToolset.Dtf.WindowsInstaller
{
using System;
using System.Collections;
using System.Collections.Generic;
using System.Globalization;
using System.Diagnostics.CodeAnalysis;
public partial class Database
{
/// <summary>
/// Gets a View object representing the query specified by a SQL string.
/// </summary>
/// <param name="sqlFormat">SQL query string, which may contain format items</param>
/// <param name="args">Zero or more objects to format</param>
/// <returns>A View object representing the query specified by a SQL string</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// The <paramref name="sqlFormat"/> parameter is formatted using <see cref="String.Format(string,object[])"/>.
/// </p><p>
/// The View object should be <see cref="InstallerHandle.Close"/>d after use.
/// It is best that the handle be closed manually as soon as it is no longer
/// needed, as leaving lots of unused handles open can degrade performance.
/// </p><p>
/// Win32 MSI API:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>
/// </p></remarks>
public View OpenView(string sqlFormat, params object[] args)
{
if (String.IsNullOrEmpty(sqlFormat))
{
throw new ArgumentNullException("sqlFormat");
}
string sql = (args == null || args.Length == 0 ? sqlFormat :
String.Format(CultureInfo.InvariantCulture, sqlFormat, args));
int viewHandle;
uint ret = RemotableNativeMethods.MsiDatabaseOpenView((int) this.Handle, sql, out viewHandle);
if (ret != 0)
{
throw InstallerException.ExceptionFromReturnCode(ret);
}
return new View((IntPtr) viewHandle, sql, this);
}
/// <summary>
/// Executes the query specified by a SQL string. The query may not be a SELECT statement.
/// </summary>
/// <param name="sqlFormat">SQL query string, which may contain format items</param>
/// <param name="args">Zero or more objects to format</param>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// The <paramref name="sqlFormat"/> parameter is formatted using
/// <see cref="String.Format(string,object[])"/>.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>
/// </p></remarks>
public void Execute(string sqlFormat, params object[] args)
{
if (String.IsNullOrEmpty(sqlFormat))
{
throw new ArgumentNullException("sqlFormat");
}
this.Execute(
args == null || args.Length == 0 ?
sqlFormat : String.Format(CultureInfo.InvariantCulture, sqlFormat, args),
(Record) null);
}
/// <summary>
/// Executes the query specified by a SQL string. The query may not be a SELECT statement.
/// </summary>
/// <param name="sql">SQL query string</param>
/// <param name="record">Optional Record object containing the values that replace
/// the parameter tokens (?) in the SQL query.</param>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>
/// </p></remarks>
public void Execute(string sql, Record record)
{
if (String.IsNullOrEmpty(sql))
{
throw new ArgumentNullException("sql");
}
using (View view = this.OpenView(sql))
{
view.Execute(record);
}
}
/// <summary>
/// Executes the specified SQL SELECT query and returns all results.
/// </summary>
/// <param name="sqlFormat">SQL query string, which may contain format items</param>
/// <param name="args">Zero or more objects to format</param>
/// <returns>All results combined into an array</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// The <paramref name="sqlFormat"/> parameter is formatted using
/// <see cref="String.Format(string,object[])"/>.
/// </p><p>
/// Multiple rows columns will be collapsed into a single one-dimensional list.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public IList ExecuteQuery(string sqlFormat, params object[] args)
{
if (String.IsNullOrEmpty(sqlFormat))
{
throw new ArgumentNullException("sqlFormat");
}
return this.ExecuteQuery(
args == null || args.Length == 0 ?
sqlFormat : String.Format(CultureInfo.InvariantCulture, sqlFormat, args),
(Record) null);
}
/// <summary>
/// Executes the specified SQL SELECT query and returns all results.
/// </summary>
/// <param name="sql">SQL SELECT query string</param>
/// <param name="record">Optional Record object containing the values that replace
/// the parameter tokens (?) in the SQL query.</param>
/// <returns>All results combined into an array</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// Multiple rows columns will be collapsed into a single one-dimensional list.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public IList ExecuteQuery(string sql, Record record)
{
if (String.IsNullOrEmpty(sql))
{
throw new ArgumentNullException("sql");
}
using (View view = this.OpenView(sql))
{
view.Execute(record);
IList results = new ArrayList();
int fieldCount = 0;
foreach (Record rec in view) using (rec)
{
if (fieldCount == 0) fieldCount = rec.FieldCount;
for (int i = 1; i <= fieldCount; i++)
{
results.Add(rec[i]);
}
}
return results;
}
}
/// <summary>
/// Executes the specified SQL SELECT query and returns all results as integers.
/// </summary>
/// <param name="sqlFormat">SQL query string, which may contain format items</param>
/// <param name="args">Zero or more objects to format</param>
/// <returns>All results combined into an array</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// The <paramref name="sqlFormat"/> parameter is formatted using
/// <see cref="String.Format(string,object[])"/>.
/// </p><p>
/// Multiple rows columns will be collapsed into a single one-dimensional list.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public IList<int> ExecuteIntegerQuery(string sqlFormat, params object[] args)
{
if (String.IsNullOrEmpty(sqlFormat))
{
throw new ArgumentNullException("sqlFormat");
}
return this.ExecuteIntegerQuery(
args == null || args.Length == 0 ?
sqlFormat : String.Format(CultureInfo.InvariantCulture, sqlFormat, args),
(Record) null);
}
/// <summary>
/// Executes the specified SQL SELECT query and returns all results as integers.
/// </summary>
/// <param name="sql">SQL SELECT query string</param>
/// <param name="record">Optional Record object containing the values that replace
/// the parameter tokens (?) in the SQL query.</param>
/// <returns>All results combined into an array</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// Multiple rows columns will be collapsed into a single one-dimensional list.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public IList<int> ExecuteIntegerQuery(string sql, Record record)
{
if (String.IsNullOrEmpty(sql))
{
throw new ArgumentNullException("sql");
}
using (View view = this.OpenView(sql))
{
view.Execute(record);
IList<int> results = new List<int>();
int fieldCount = 0;
foreach (Record rec in view) using (rec)
{
if (fieldCount == 0) fieldCount = rec.FieldCount;
for (int i = 1; i <= fieldCount; i++)
{
results.Add(rec.GetInteger(i));
}
}
return results;
}
}
/// <summary>
/// Executes the specified SQL SELECT query and returns all results as strings.
/// </summary>
/// <param name="sqlFormat">SQL query string, which may contain format items</param>
/// <param name="args">Zero or more objects to format</param>
/// <returns>All results combined into an array</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// The <paramref name="sqlFormat"/> parameter is formatted using
/// <see cref="String.Format(string,object[])"/>.
/// </p><p>
/// Multiple rows columns will be collapsed into a single on-dimensional list.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public IList<string> ExecuteStringQuery(string sqlFormat, params object[] args)
{
if (String.IsNullOrEmpty(sqlFormat))
{
throw new ArgumentNullException("sqlFormat");
}
return this.ExecuteStringQuery(
args == null || args.Length == 0 ?
sqlFormat : String.Format(CultureInfo.InvariantCulture, sqlFormat, args),
(Record) null);
}
/// <summary>
/// Executes the specified SQL SELECT query and returns all results as strings.
/// </summary>
/// <param name="sql">SQL SELECT query string</param>
/// <param name="record">Optional Record object containing the values that replace
/// the parameter tokens (?) in the SQL query.</param>
/// <returns>All results combined into an array</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// Multiple rows columns will be collapsed into a single on-dimensional list.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public IList<string> ExecuteStringQuery(string sql, Record record)
{
if (String.IsNullOrEmpty(sql))
{
throw new ArgumentNullException("sql");
}
using (View view = this.OpenView(sql))
{
view.Execute(record);
IList<string> results = new List<string>();
int fieldCount = 0;
foreach (Record rec in view) using (rec)
{
if (fieldCount == 0) fieldCount = rec.FieldCount;
for (int i = 1; i <= fieldCount; i++)
{
results.Add(rec.GetString(i));
}
}
return results;
}
}
/// <summary>
/// Executes the specified SQL SELECT query and returns a single result.
/// </summary>
/// <param name="sqlFormat">SQL query string, which may contain format items</param>
/// <param name="args">Zero or more objects to format</param>
/// <returns>First field of the first result</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed
/// or the query returned 0 results</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// The <paramref name="sqlFormat"/> parameter is formatted using
/// <see cref="String.Format(string,object[])"/>.
/// </p><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public object ExecuteScalar(string sqlFormat, params object[] args)
{
if (String.IsNullOrEmpty(sqlFormat))
{
throw new ArgumentNullException("sqlFormat");
}
return this.ExecuteScalar(
args == null || args.Length == 0 ?
sqlFormat : String.Format(CultureInfo.InvariantCulture, sqlFormat, args),
(Record) null);
}
/// <summary>
/// Executes the specified SQL SELECT query and returns a single result.
/// </summary>
/// <param name="sql">SQL SELECT query string</param>
/// <param name="record">Optional Record object containing the values that replace
/// the parameter tokens (?) in the SQL query.</param>
/// <returns>First field of the first result</returns>
/// <exception cref="BadQuerySyntaxException">the SQL syntax is invalid</exception>
/// <exception cref="InstallerException">the View could not be executed
/// or the query returned 0 results</exception>
/// <exception cref="InvalidHandleException">the Database handle is invalid</exception>
/// <remarks><p>
/// Win32 MSI APIs:
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,
/// <a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>
/// </p></remarks>
public object ExecuteScalar(string sql, Record record)
{
if (String.IsNullOrEmpty(sql))
{
throw new ArgumentNullException("sql");
}
View view = this.OpenView(sql);
Record rec = null;
try
{
view.Execute(record);
rec = view.Fetch();
if (rec == null)
{
throw InstallerException.ExceptionFromReturnCode((uint) NativeMethods.Error.NO_MORE_ITEMS);
}
return rec[1];
}
finally
{
if (rec != null) rec.Close();
view.Close();
}
}
}
}
|
