~jterrell/nunitv2/nunitv2 : revision 3373

1

<?xml version="1.0"?>

2

<doc>

3

4

<name>Microsoft.Deployment.WindowsInstaller</name>

5

</assembly>

6

7

8

9

Collection of column information related to a <see cref="T:Microsoft.Deployment.WindowsInstaller.TableInfo"/> or

10

<see cref="T:Microsoft.Deployment.WindowsInstaller.View"/>.

11

</summary>

12

</member>

13

14

15

Creates a new ColumnCollection based on a specified list of columns.

16

</summary>

17

<param name="columns">columns to be added to the new collection</param>

18

</member>

19

20

21

Creates a new ColumnCollection that is associated with a database table.

22

</summary>

23

<param name="view">view that contains the columns</param>

24

</member>

25

26

27

Not supported because the collection is read-only.

28

</summary>

29

<param name="item">information about the column being added</param>

30

<exception cref="T:System.InvalidOperationException">the collection is read-only</exception>

31

</member>

32

33

34

Not supported because the collection is read-only.

35

</summary>

36

<exception cref="T:System.InvalidOperationException">the collection is read-only</exception>

37

</member>

38

39

40

Checks if a column with a given name exists in the collection.

41

</summary>

42

<param name="columnName">case-sensitive name of the column to look for</param>

43

<returns>true if the column exists in the collection, false otherwise</returns>

44

</member>

45

46

47

Checks if a column with a given name exists in the collection.

48

</summary>

49

<param name="column">column to look for, with case-sensitive name</param>

50

<returns>true if the column exists in the collection, false otherwise</returns>

51

</member>

52

53

54

Gets the index of a column within the collection.

55

</summary>

56

<param name="columnName">case-sensitive name of the column to look for</param>

57

<returns>0-based index of the column, or -1 if not found</returns>

58

</member>

59

60

61

Copies the columns from this collection into an array.

62

</summary>

63

<param name="array">destination array to be filed</param>

64

<param name="arrayIndex">offset into the destination array where copying begins</param>

65

</member>

66

67

68

Not supported because the collection is read-only.

69

</summary>

70

<param name="column">column to remove</param>

71

<returns>true if the column was removed, false if it was not found</returns>

72

<exception cref="T:System.InvalidOperationException">the collection is read-only</exception>

73

</member>

74

75

76

Gets an enumerator over the columns in the collection.

77

</summary>

78

<returns>An enumerator of ColumnInfo objects.</returns>

79

</member>

80

81

82

Gets an enumerator over the columns in the collection.

83

</summary>

84

<returns>An enumerator of ColumnInfo objects.</returns>

85

</member>

86

87

88

Creates ColumnInfo objects for the associated view.

89

</summary>

90

<returns>dynamically-generated list of columns</returns>

91

</member>

92

93

94

Gets a list of column names or column-definition-strings for the

95

associated view.

96

</summary>

97

<param name="view">the view to that defines the columns</param>

98

<param name="types">true to return types (column definition strings),

99

false to return names</param>

100

<returns>list of column names or types</returns>

101

</member>

102

103

104

Gets the number of columns in the collection.

105

</summary>

106

<value>number of columns in the collection</value>

107

</member>

108

109

110

Gets a boolean value indicating whether the collection is read-only.

111

A ColumnCollection is read-only if it is associated with a <see cref="T:Microsoft.Deployment.WindowsInstaller.View"/>

112

or a read-only <see cref="T:Microsoft.Deployment.WindowsInstaller.Database"/>.

113

</summary>

114

<value>read-only status of the collection</value>

115

</member>

116

117

118

Gets information about a specific column in the collection.

119

</summary>

120

<param name="columnIndex">1-based index into the column collection</param>

121

<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less

122

than 1 or greater than the number of columns in the collection</exception>

123

</member>

124

125

126

Gets information about a specific column in the collection.

127

</summary>

128

<param name="columnName">case-sensitive name of a column collection</param>

129

<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnName"/> does

130

not exist in the collection</exception>

131

</member>

132

133

134

Gets a string suitable for printing all the values of a record containing these columns.

135

</summary>

136

</member>

137

138

139

Available values for the Attributes column of the Component table.

140

</summary>

141

</member>

142

143

144

Local only - Component cannot be run from source.

145

</summary>

146

147

Set this value for all components belonging to a feature to prevent the feature from being run-from-network or

148

run-from-source. Note that if a feature has no components, the feature always shows run-from-source and

149

run-from-my-computer as valid options.

150

</remarks>

151

</member>

152

153

154

Component can only be run from source.

155

</summary>

156

157

Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer.

158

Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer

159

as valid options.

160

</remarks>

161

</member>

162

163

164

Component can run locally or from source.

165

</summary>

166

</member>

167

168

169

If this bit is set, the value in the KeyPath column is used as a key into the Registry table.

170

</summary>

171

172

If the Value field of the corresponding record in the Registry table is null, the Name field in that record

173

must not contain "+", "-", or "*". For more information, see the description of the Name field in Registry

174

table.

175

Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer

176

writes the necessary HKCU registry entries when there are multiple users on the same machine.

177

</remarks>

178

</member>

179

180

181

If this bit is set, the installer increments the reference count in the shared DLL registry of the component's

182

key file. If this bit is not set, the installer increments the reference count only if the reference count

183

already exists.

184

</summary>

185

</member>

186

187

188

If this bit is set, the installer does not remove the component during an uninstall. The installer registers

189

an extra system client for the component in the Windows Installer registry settings.

190

</summary>

191

</member>

192

193

194

If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table.

195

</summary>

196

</member>

197

198

199

If this bit is set, the installer reevaluates the value of the statement in the Condition column upon a reinstall.

200

If the value was previously False and has changed to true, the installer installs the component. If the value

201

was previously true and has changed to false, the installer removes the component even if the component has

202

other products as clients.

203

</summary>

204

</member>

205

206

207

If this bit is set, the installer does not install or reinstall the component if a key path file or a key path

208

registry entry for the component already exists. The application does register itself as a client of the component.

209

</summary>

210

211

Use this flag only for components that are being registered by the Registry table. Do not use this flag for

212

components registered by the AppId, Class, Extension, ProgId, MIME, and Verb tables.

213

</remarks>

214

</member>

215

216

217

Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of packages that

218

include both 32-bit and 64-bit components. If this bit is not set, the component is registered as a 32-bit component.

219

</summary>

220

221

If this is a 64-bit component replacing a 32-bit component, set this bit and assign a new GUID in the

222

ComponentId column.

223

</remarks>

224

</member>

225

226

227

Set this bit to disable registry reflection on all existing and new registry keys affected by this component.

228

</summary>

229

230

If this bit is set, the Windows Installer calls the RegDisableReflectionKey on each key being accessed by the component.

231

This bit is available with Windows Installer version 4.0 and is ignored on 32-bit systems.

232

</remarks>

233

</member>

234

235

236

[MSI 4.5] Set this bit for a component in a patch package to prevent leaving orphan components on the computer.

237

</summary>

238

239

If a subsequent patch is installed, marked with the SupersedeEarlier flag in its MsiPatchSequence

240

table to supersede the first patch, Windows Installer 4.5 can unregister and uninstall components marked with the

241

UninstallOnSupersedence value. If the component is not marked with this bit, installation of a superseding patch can leave

242

behind an unused component on the computer.

243

</remarks>

244

</member>

245

246

247

[MSI 4.5] If a component is marked with this attribute value in at least one package installed on the system,

248

the installer treats the component as marked in all packages. If a package that shares the marked component

249

is uninstalled, Windows Installer 4.5 can continue to share the highest version of the component on the system,

250

even if that highest version was installed by the package that is being uninstalled.

251

</summary>

252

</member>

253

254

255

Defines flags for the Attributes column of the Control table.

256

</summary>

257

</member>

258

259

<summary>If this bit is set, the control is visible on the dialog box.</summary>

260

</member>

261

262

<summary>specifies if the given control is enabled or disabled. Most controls appear gray when disabled.</summary>

263

</member>

264

265

<summary>If this bit is set, the control is displayed with a sunken, three dimensional look.</summary>

266

</member>

267

268

<summary>The Indirect control attribute specifies whether the value displayed or changed by this control is referenced indirectly.</summary>

269

</member>

270

271

<summary>If this bit is set on a control, the associated property specified in the Property column of the Control table is an integer.</summary>

272

</member>

273

274

<summary>If this bit is set the text in the control is displayed in a right-to-left reading order.</summary>

275

</member>

276

277

<summary>If this style bit is set, text in the control is aligned to the right.</summary>

278

</member>

279

280

<summary>If this bit is set, the scroll bar is located on the left side of the control, otherwise it is on the right.</summary>

281

</member>

282

283

<summary>This is a combination of the RightToLeftReadingOrder, RightAligned, and LeftScroll attributes.</summary>

284

</member>

285

286

<summary>If this bit is set on a text control, the control is displayed transparently with the background showing through the control where there are no characters.</summary>

287

</member>

288

289

<summary>If this bit is set on a text control, the occurrence of the character "&" in a text string is displayed as itself.</summary>

290

</member>

291

292

<summary>If this bit is set the text in the control is displayed on a single line.</summary>

293

</member>

294

295

<summary>If this bit is set for a text control, the control will automatically attempt to format the displayed text as a number representing a count of bytes.</summary>

296

</member>

297

298

<summary>If this bit is set, fonts are created using the user's default UI code page. Otherwise it is created using the database code page.</summary>

299

</member>

300

301

<summary>If this bit is set on an Edit control, the installer creates a multiple line edit control with a vertical scroll bar.</summary>

302

</member>

303

304

<summary>This attribute creates an edit control for entering passwords. The control displays each character as an asterisk (*) as they are typed into the control.</summary>

305

</member>

306

307

<summary>If this bit is set on a ProgressBar control, the bar is drawn as a series of small rectangles in Microsoft Windows 95-style. Otherwise it is drawn as a single continuous rectangle.</summary>

308

</member>

309

310

<summary>If this bit is set, the control shows removable volumes.</summary>

311

</member>

312

313

<summary>If this bit is set, the control shows fixed internal hard drives.</summary>

314

</member>

315

316

<summary>If this bit is set, the control shows remote volumes.</summary>

317

</member>

318

319

<summary>If this bit is set, the control shows CD-ROM volumes.</summary>

320

</member>

321

322

<summary>If this bit is set, the control shows RAM disk volumes.</summary>

323

</member>

324

325

<summary>If this bit is set, the control shows floppy volumes.</summary>

326

</member>

327

328

<summary>Specifies whether or not the rollback backup files are included in the costs displayed by the VolumeCostList control.</summary>

329

</member>

330

331

<summary>If this bit is set, the items listed in the control are displayed in a specified order. Otherwise, items are displayed in alphabetical order.</summary>

332

</member>

333

334

<summary>If this bit is set on a combo box, the edit field is replaced by a static text field. This prevents a user from entering a new value and requires the user to choose only one of the predefined values.</summary>

335

</member>

336

337

<summary>If this bit is set on a check box or a radio button group, the button is drawn with the appearance of a push button, but its logic stays the same.</summary>

338

</member>

339

340

<summary>If this bit is set, the text in the control is replaced by a bitmap image. The Text column in the Control table is a foreign key into the Binary table.</summary>

341

</member>

342

343

<summary>If this bit is set, text is replaced by an icon image and the Text column in the Control table is a foreign key into the Binary table.</summary>

344

</member>

345

346

<summary>If this bit is set, the picture is cropped or centered in the control without changing its shape or size.</summary>

347

</member>

348

349

<summary>Specifies which size of the icon image to load. If none of the bits are set, the first image is loaded.</summary>

350

</member>

351

352

<summary>Specifies which size of the icon image to load. If none of the bits are set, the first image is loaded.</summary>

353

</member>

354

355

<summary>Specifies which size of the icon image to load. If none of the bits are set, the first image is loaded.</summary>

356

</member>

357

358

<summary>If this bit is set, and the installation is not yet running with elevated privileges, the control is created with a UAC icon.</summary>

359

</member>

360

361

<summary>If this bit is set, the RadioButtonGroup has text and a border displayed around it.</summary>

362

</member>

363

364

365

Defines flags for the Type column of the CustomAction table.

366

</summary>

367

</member>

368

369

<summary>Unspecified custom action type.</summary>

370

</member>

371

372

<summary>Target = entry point name</summary>

373

</member>

374

375

<summary>Target = command line args</summary>

376

</member>

377

378

<summary>Target = text string to be formatted and set into property</summary>

379

</member>

380

381

<summary>Target = entry point name, null if none to call</summary>

382

</member>

383

384

<summary>Target = entry point name, null if none to call</summary>

385

</member>

386

387

<summary>Target = property list for nested engine initialization</summary>

388

</member>

389

390

<summary>Source = File.File, file part of installation</summary>

391

</member>

392

393

<summary>Source = Directory.Directory, folder containing existing file</summary>

394

</member>

395

396

<summary>Source = Property.Property, full path to executable</summary>

397

</member>

398

399

<summary>Ignore action return status, continue running</summary>

400

</member>

401

402

<summary>Run asynchronously</summary>

403

</member>

404

405

<summary>Skip if UI sequence already run</summary>

406

</member>

407

408

<summary>Skip if UI sequence already run in same process</summary>

409

</member>

410

411

<summary>Run on client only if UI already run on client</summary>

412

</member>

413

414

<summary>Queue for execution within script</summary>

415

</member>

416

417

<summary>In conjunction with InScript: queue in Rollback script</summary>

418

</member>

419

420

<summary>In conjunction with InScript: run Commit ops from script on success</summary>

421

</member>

422

423

<summary>No impersonation, run in system context</summary>

424

</member>

425

426

<summary>Impersonate for per-machine installs on TS machines</summary>

427

</member>

428

429

<summary>Script requires 64bit process</summary>

430

</member>

431

432

<summary>Don't record the contents of the Target field in the log file</summary>

433

</member>

434

435

<summary>The custom action runs only when a patch is being uninstalled</summary>

436

</member>

437

438

439

Defines flags for the Attributes column of the Dialog table.

440

</summary>

441

</member>

442

443

<summary>If this bit is set, the dialog is originally created as visible, otherwise it is hidden.</summary>

444

</member>

445

446

<summary>If this bit is set, the dialog box is modal, other dialogs of the same application cannot be put on top of it, and the dialog keeps the control while it is running.</summary>

447

</member>

448

449

<summary>If this bit is set, the dialog box can be minimized. This bit is ignored for modal dialog boxes, which cannot be minimized.</summary>

450

</member>

451

452

<summary>If this style bit is set, the dialog box will stop all other applications and no other applications can take the focus.</summary>

453

</member>

454

455

<summary>If this bit is set, the other dialogs stay alive when this dialog box is created.</summary>

456

</member>

457

458

<summary>If this bit is set, the dialog box periodically calls the installer. If the property changes, it notifies the controls on the dialog.</summary>

459

</member>

460

461

<summary>If this bit is set, the pictures on the dialog box are created with the custom palette (one per dialog received from the first control created).</summary>

462

</member>

463

464

<summary>If this style bit is set the text in the dialog box is displayed in right-to-left-reading order.</summary>

465

</member>

466

467

<summary>If this style bit is set, the text is aligned on the right side of the dialog box.</summary>

468

</member>

469

470

<summary>If this style bit is set, the scroll bar is located on the left side of the dialog box.</summary>

471

</member>

472

473

<summary>This is a combination of the RightToLeftReadingOrder, RightAligned, and the LeftScroll dialog style bits.</summary>

474

</member>

475

476

<summary>If this bit is set, the dialog box is an error dialog.</summary>

477

</member>

478

479

480

Available values for the Attributes column of the Feature table.

481

</summary>

482

</member>

483

484

485

Favor local - Components of this feature that are not marked for installation from source are installed locally.

486

</summary>

487

488

A component shared by two or more features, some of which are set to FavorLocal and some to FavorSource,

489

is installed locally. Components marked <see cref="F:Microsoft.Deployment.WindowsInstaller.ComponentAttributes.SourceOnly"/> in the Component

490

table are always run from the source CD/server. The bits FavorLocal and FavorSource work with features not

491

listed by the ADVERTISE property.

492

</remarks>

493

</member>

494

495

496

Components of this feature not marked for local installation are installed to run from the source

497

CD-ROM or server.

498

</summary>

499

500

A component shared by two or more features, some of which are set to FavorLocal and some to FavorSource,

501

is installed to run locally. Components marked <see cref="F:Microsoft.Deployment.WindowsInstaller.ComponentAttributes.None"/> (local-only) in the

502

Component table are always installed locally. The bits FavorLocal and FavorSource work with features

503

not listed by the ADVERTISE property.

504

</remarks>

505

</member>

506

507

508

Set this attribute and the state of the feature is the same as the state of the feature's parent.

509

You cannot use this option if the feature is located at the root of a feature tree.

510

</summary>

511

512

Omit this attribute and the feature state is determined according to DisallowAdvertise and

513

FavorLocal and FavorSource.

514

To guarantee that the child feature's state always follows the state of its parent, even when the

515

child and parent are initially set to absent in the SelectionTree control, you must include both

516

FollowParent and UIDisallowAbsent in the attributes of the child feature.

517

Note that if you set FollowParent without setting UIDisallowAbsent, the installer cannot force

518

the child feature out of the absent state. In this case, the child feature matches the parent's

519

installation state only if the child is set to something other than absent.

520

Set FollowParent and UIDisallowAbsent to ensure a child feature follows the state of the parent feature.

521

</remarks>

522

</member>

523

524

525

Set this attribute and the feature state is Advertise.

526

</summary>

527

528

If the feature is listed by the ADDDEFAULT property this bit is ignored and the feature state is determined

529

according to FavorLocal and FavorSource.

530

Omit this attribute and the feature state is determined according to DisallowAdvertise and FavorLocal

531

and FavorSource.

532

</remarks>

533

</member>

534

535

536

Set this attribute to prevent the feature from being advertised.

537

</summary>

538

539

Note that this bit works only with features that are listed by the ADVERTISE property.

540

Set this attribute and if the listed feature is not a parent or child, the feature is installed according to

541

FavorLocal and FavorSource.

542

Set this attribute for the parent of a listed feature and the parent is installed.

543

Set this attribute for the child of a listed feature and the state of the child is Absent.

544

Omit this attribute and if the listed feature is not a parent or child, the feature state is Advertise.

545

Omit this attribute and if the listed feature is a parent or child, the state of both features is Advertise.

546

</remarks>

547

</member>

548

549

550

Set this attribute and the user interface does not display an option to change the feature state

551

to Absent. Setting this attribute forces the feature to the installation state, whether or not the

552

feature is visible in the UI.

553

</summary>

554

555

Omit this attribute and the user interface displays an option to change the feature state to Absent.

556

Set FollowParent and UIDisallowAbsent to ensure a child feature follows the state of the parent feature.

557

Setting this attribute not only affects the UI, but also forces the feature to the install state whether

558

the feature is visible in the UI or not.

559

</remarks>

560

</member>

561

562

563

Set this attribute and advertising is disabled for the feature if the operating system shell does not

564

support Windows Installer descriptors.

565

</summary>

566

</member>

567

568

569

Available values for the Attributes column of the File table.

570

</summary>

571

</member>

572

573

<summary>No attributes.</summary>

574

</member>

575

576

577

</member>

578

579

<summary>Hidden.</summary>

580

</member>

581

582

<summary>System.</summary>

583

</member>

584

585

<summary>The file is vital for the proper operation of the component to which it belongs.</summary>

586

</member>

587

588

<summary>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</summary>

589

</member>

590

591

<summary>This bit must only be added by a patch and if the file is being added by the patch.</summary>

592

</member>

593

594

595

The file's source type is uncompressed. If set, ignore the WordCount summary information property. If neither

596

Noncompressed nor Compressed are set, the compression state of the file is specified by the WordCount summary

597

information property. Do not set both Noncompressed and Compressed.

598

</summary>

599

</member>

600

601

602

The file's source type is compressed. If set, ignore the WordCount summary information property. If neither

603

Noncompressed or Compressed are set, the compression state of the file is specified by the WordCount summary

604

information property. Do not set both Noncompressed and Compressed.

605

</summary>

606

</member>

607

608

609

Defines values for the Action column of the IniFile and RemoveIniFile tables.

610

</summary>

611

</member>

612

613

<summary>Creates or updates a .ini entry.</summary>

614

</member>

615

616

<summary>Creates a .ini entry only if the entry does not already exist.</summary>

617

</member>

618

619

<summary>Deletes .ini entry.</summary>

620

</member>

621

622

<summary>Creates a new entry or appends a new comma-separated value to an existing entry.</summary>

623

</member>

624

625

<summary>Deletes a tag from a .ini entry.</summary>

626

</member>

627

628

629

Defines values for the Type column of the CompLocator, IniLocator, and RegLocator tables.

630

</summary>

631

</member>

632

633

<summary>Key path is a directory.</summary>

634

</member>

635

636

637

</member>

638

639

<summary>Key path is a registry value.</summary>

640

</member>

641

642

<summary>Set this bit to have the installer search the 64-bit portion of the registry.</summary>

643

</member>

644

645

646

Defines values for the Root column of the Registry, RemoveRegistry, and RegLocator tables.

647

</summary>

648

</member>

649

650

<summary>HKEY_CURRENT_USER for a per-user installation,

651

or HKEY_LOCAL_MACHINE for a per-machine installation.</summary>

652

</member>

653

654

<summary>HKEY_CLASSES_ROOT</summary>

655

</member>

656

657

<summary>HKEY_CURRENT_USER</summary>

658

</member>

659

660

<summary>HKEY_LOCAL_MACHINE</summary>

661

</member>

662

663

<summary>HKEY_USERS</summary>

664

</member>

665

666

667

Defines values for the InstallMode column of the RemoveFile table.

668

</summary>

669

</member>

670

671

<summary>Never remove.</summary>

672

</member>

673

674

<summary>Remove when the associated component is being installed (install state = local or source).</summary>

675

</member>

676

677

<summary>Remove when the associated component is being removed (install state = absent).</summary>

678

</member>

679

680

681

Defines values for the ServiceType, StartType, and ErrorControl columns of the ServiceInstall table.

682

</summary>

683

</member>

684

685

<summary>No flags.</summary>

686

</member>

687

688

<summary>A Win32 service that runs its own process.</summary>

689

</member>

690

691

<summary>A Win32 service that shares a process.</summary>

692

</member>

693

694

<summary>A Win32 service that interacts with the desktop.

695

This value cannot be used alone and must be added to either

696

697

</member>

698

699

<summary>Service starts during startup of the system.</summary>

700

</member>

701

702

<summary>Service starts when the service control manager calls the StartService function.</summary>

703

</member>

704

705

<summary>Specifies a service that can no longer be started.</summary>

706

</member>

707

708

<summary>Logs the error, displays a message box and continues the startup operation.</summary>

709

</member>

710

711

<summary>Logs the error if it is possible and the system is restarted with the last configuration

712

known to be good. If the last-known-good configuration is being started, the startup operation fails.</summary>

713

</member>

714

715

<summary>When combined with other error flags, specifies that the overall install should fail if

716

the service cannot be installed into the system.</summary>

717

</member>

718

719

720

Defines values for the Event column of the ServiceControl table.

721

</summary>

722

</member>

723

724

<summary>No control events.</summary>

725

</member>

726

727

<summary>During an install, starts the service during the StartServices action.</summary>

728

</member>

729

730

<summary>During an install, stops the service during the StopServices action.</summary>

731

</member>

732

733

<summary>During an install, deletes the service during the DeleteServices action.</summary>

734

</member>

735

736

<summary>During an uninstall, starts the service during the StartServices action.</summary>

737

</member>

738

739

<summary>During an uninstall, stops the service during the StopServices action.</summary>

740

</member>

741

742

<summary>During an uninstall, deletes the service during the DeleteServices action.</summary>

743

</member>

744

745

746

Defines values for the StyleBits column of the TextStyle table.

747

</summary>

748

</member>

749

750

751

</member>

752

753

<summary>Italic</summary>

754

</member>

755

756

<summary>Underline</summary>

757

</member>

758

759

<summary>Strike out</summary>

760

</member>

761

762

763

Defines values for the Attributes column of the Upgrade table.

764

</summary>

765

</member>

766

767

<summary>Migrates feature states by enabling the logic in the MigrateFeatureStates action.</summary>

768

</member>

769

770

<summary>Detects products and applications but does not remove.</summary>

771

</member>

772

773

<summary>Continues installation upon failure to remove a product or application.</summary>

774

</member>

775

776

<summary>Detects the range of versions including the value in VersionMin.</summary>

777

</member>

778

779

<summary>Dectects the range of versions including the value in VersionMax.</summary>

780

</member>

781

782

<summary>Detects all languages, excluding the languages listed in the Language column.</summary>

783

</member>

784

785

786

Defines a single column of a table in an installer database.

787

</summary>

788

<remarks>Once created, a ColumnInfo object is immutable.</remarks>

789

</member>

790

791

792

Creates a new ColumnInfo object from a column definition.

793

</summary>

794

<param name="name">name of the column</param>

795

<param name="columnDefinition">column definition string</param>

796

797

</member>

798

799

800

Creates a new ColumnInfo object from a list of parameters.

801

</summary>

802

<param name="name">name of the column</param>

803

<param name="type">type of the column; must be one of the following:

804

Int16, Int32, String, or Stream</param>

805

<param name="size">the maximum number of characters for String columns;

806

ignored for other column types</param>

807

<param name="isRequired">true if the column is required to have a non-null value</param>

808

</member>

809

810

811

Creates a new ColumnInfo object from a list of parameters.

812

</summary>

813

<param name="name">name of the column</param>

814

<param name="type">type of the column; must be one of the following:

815

Int16, Int32, String, or Stream</param>

816

<param name="size">the maximum number of characters for String columns;

817

ignored for other column types</param>

818

<param name="isRequired">true if the column is required to have a non-null value</param>

819

<param name="isTemporary">true to if the column is only in-memory and

820

not persisted with the database</param>

821

<param name="isLocalizable">for String columns, indicates the column

822

is localizable; ignored for other column types</param>

823

</member>

824

825

826

Gets the name of the column.

827

</summary>

828

<returns>Name of the column.</returns>

829

</member>

830

831

832

Gets the name of the column.

833

</summary>

834

<value>name of the column</value>

835

</member>

836

837

838

Gets the type of the column as a System.Type. This is one of the following: Int16, Int32, String, or Stream

839

</summary>

840

<value>type of the column</value>

841

</member>

842

843

844

Gets the type of the column as an integer that can be cast to a System.Data.DbType. This is one of the following: Int16, Int32, String, or Binary

845

</summary>

846

<value>equivalent DbType of the column as an integer</value>

847

</member>

848

849

850

Gets the size of the column.

851

</summary>

852

<value>The size of integer columns this is either 2 or 4. For string columns this is the maximum

853

recommended length of the string, or 0 for unlimited length. For stream columns, 0 is returned.</value>

854

</member>

855

856

857

Gets a value indicating whether the column must be non-null when inserting a record.

858

</summary>

859

<value>required status of the column</value>

860

</member>

861

862

863

Gets a value indicating whether the column is temporary. Temporary columns are not persisted

864

when the database is saved to disk.

865

</summary>

866

<value>temporary status of the column</value>

867

</member>

868

869

870

Gets a value indicating whether the column is a string column that is localizable.

871

</summary>

872

<value>localizable status of the column</value>

873

</member>

874

875

876

Gets an SQL fragment that can be used to create this column within a CREATE TABLE statement.

877

</summary>

878

<value>SQL fragment to be used for creating the column</value>

879

880

Examples:

881

882

883

<item>SHORT TEMPORARY</item>

884

<item>CHAR(0) LOCALIZABLE</item>

885

<item>CHAR(72) NOT NULL LOCALIZABLE</item>

886

<item>OBJECT</item>

887

</list>

888

</remarks>

889

</member>

890

891

892

Gets a short string defining the type and size of the column.

893

</summary>

894

<value>

895

The definition string consists

896

of a single letter representing the data type followed by the width of the column (in characters

897

when applicable, bytes otherwise). A width of zero designates an unbounded width (for example,

898

long text fields and streams). An uppercase letter indicates that null values are allowed in

899

the column.

900

</value>

901

902

<list>

903

<item>s? - String, variable length (?=1-255)</item>

904

<item>s0 - String, variable length</item>

905

<item>i2 - Short integer</item>

906

<item>i4 - Long integer</item>

907

<item>v0 - Binary Stream</item>

908

<item>g? - Temporary string (?=0-255)</item>

909

<item>j? - Temporary integer (?=0,1,2,4)</item>

910

<item>l? - Localizable string, variable length (?=1-255)</item>

911

<item>l0 - Localizable string, variable length</item>

912

</list>

913

</remarks>

914

</member>

915

916

917

Accessor for information about components within the context of an installation session.

918

</summary>

919

</member>

920

921

922

Checks if the collection contains a component.

923

</summary>

924

<param name="component">name of the component</param>

925

<returns>true if the component is in the collection, else false</returns>

926

</member>

927

928

929

Copies the features into an array.

930

</summary>

931

<param name="array">array that receives the features</param>

932

<param name="arrayIndex">offset into the array</param>

933

</member>

934

935

936

Enumerates the components in the collection.

937

</summary>

938

<returns>an enumerator over all features in the collection</returns>

939

</member>

940

941

942

Gets information about a component within the context of an installation session.

943

</summary>

944

<param name="component">name of the component</param>

945

<returns>component object</returns>

946

</member>

947

948

949

Gets the number of components defined for the product.

950

</summary>

951

</member>

952

953

954

Provides access to information about a component within the context of an installation session.

955

</summary>

956

</member>

957

958

959

Gets disk space per drive required to install a component.

960

</summary>

961

<param name="installState">Requested component state</param>

962

<returns>A list of InstallCost structures, specifying the cost for each drive for the component</returns>

963

964

Win32 MSI API:

965

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumcomponentcosts.asp">MsiEnumComponentCosts</a>

966

</remarks>

967

</member>

968

969

970

Gets the name of the component (primary key in the Component table).

971

</summary>

972

</member>

973

974

975

Gets the current install state of the designated Component.

976

</summary>

977

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

978

<exception cref="T:System.ArgumentException">an unknown Component was requested</exception>

979

980

Win32 MSI API:

981

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetcomponentstate.asp">MsiGetComponentState</a>

982

</remarks>

983

</member>

984

985

986

Gets or sets the action state of the designated Component.

987

</summary>

988

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

989

<exception cref="T:System.ArgumentException">an unknown Component was requested</exception>

990

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

991

992

Win32 MSI APIs:

993

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetcomponentstate.asp">MsiGetComponentState</a>,

994

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetcomponentstate.asp">MsiSetComponentState</a>

995

</remarks>

996

</member>

997

998

999

Represents an instance of a registered component.

1000

</summary>

1001

</member>

1002

1003

1004

Subclasses of this abstract class represent an instance

1005

of a registered feature or component.

1006

</summary>

1007

</member>

1008

1009

1010

Gets the product that this item is a part of.

1011

</summary>

1012

</member>

1013

1014

1015

Gets the current installation state of the item.

1016

</summary>

1017

</member>

1018

1019

1020

Creates a new ComponentInstallation, automatically detecting the

1021

product that the component is a part of.

1022

</summary>

1023

<param name="componentCode">component GUID</param>

1024

1025

Win32 MSI API:

1026

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetproductcode.asp">MsiGetProductCode</a>

1027

</remarks>

1028

</member>

1029

1030

1031

Creates a new ComponentInstallation for a component installed by a

1032

specific product.

1033

</summary>

1034

<param name="componentCode">component GUID</param>

1035

<param name="productCode">ProductCode GUID</param>

1036

</member>

1037

1038

1039

Gets the set of installed components for all products.

1040

</summary>

1041

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

1042

1043

Win32 MSI API:

1044

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumcomponents.asp">MsiEnumComponents</a>

1045

</remarks>

1046

</member>

1047

1048

1049

Gets the component code (GUID) of the component.

1050

</summary>

1051

</member>

1052

1053

1054

Gets all client products of a specified component.

1055

</summary>

1056

<returns>enumeration over all client products of the component</returns>

1057

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

1058

1059

Because clients are not ordered, any new component has an arbitrary index.

1060

This means that the property may return clients in any order.

1061

1062

Win32 MSI API:

1063

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumclients.asp">MsiEnumClients</a>

1064

</remarks>

1065

</member>

1066

1067

1068

Gets the installed state of a component.

1069

</summary>

1070

<returns>the installed state of the component, or InstallState.Unknown

1071

if this component is not part of a product</returns>

1072

1073

Win32 MSI API:

1074

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetcomponentpath.asp">MsiGetComponentPath</a>

1075

</remarks>

1076

</member>

1077

1078

1079

Gets the full path to an installed component. If the key path for the component is a

1080

registry key then the registry key is returned.

1081

</summary>

1082

<returns>The file or registry keypath to the component, or null if the component is not available.</returns>

1083

<exception cref="T:System.ArgumentException">An unknown product or component was specified</exception>

1084

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

1085

1086

If the component is a registry key, the registry roots are represented numerically.

1087

For example, a registry path of "HKEY_CURRENT_USER\SOFTWARE\Microsoft" would be returned

1088

as "01:\SOFTWARE\Microsoft". The registry roots returned are defined as follows:

1089

HKEY_CLASSES_ROOT=00, HKEY_CURRENT_USER=01, HKEY_LOCAL_MACHINE=02, HKEY_USERS=03,

1090

HKEY_PERFORMANCE_DATA=04

1091

1092

Win32 MSI APIs:

1093

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetcomponentpath.asp">MsiGetComponentPath</a>,

1094

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msilocatecomponent.asp">MsiLocateComponent</a>

1095

</remarks>

1096

</member>

1097

1098

1099

Gets the set of registered qualifiers for the component.

1100

</summary>

1101

<returns>Enumeration of the qulifiers for the component.</returns>

1102

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

1103

1104

Because qualifiers are not ordered, any new qualifier has an arbitrary index,

1105

meaning the function can return qualifiers in any order.

1106

1107

Win32 MSI API:

1108

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumcomponentqualifiers.asp">MsiEnumComponentQualifiers</a>

1109

</remarks>

1110

</member>

1111

1112

1113

Holds data about a component qualifier.

1114

</summary>

1115

1116

Win32 MSI API:

1117

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumcomponentqualifiers.asp">MsiEnumComponentQualifiers</a>

1118

</remarks>

1119

</member>

1120

1121

1122

Gets the qualifier code.

1123

</summary>

1124

</member>

1125

1126

1127

Gets the qualifier data.

1128

</summary>

1129

</member>

1130

1131

1132

Marks a method as a custom action entry point.

1133

</summary>

1134

1135

A custom action method must be defined as public and static,

1136

take a single <see cref="T:Microsoft.Deployment.WindowsInstaller.Session"/> object as a parameter,

1137

and return an <see cref="T:Microsoft.Deployment.WindowsInstaller.ActionResult"/> enumeration value.

1138

</remarks>

1139

</member>

1140

1141

1142

Name of the custom action entrypoint, or null if the same as the method name.

1143

</summary>

1144

</member>

1145

1146

1147

Marks a method as a custom action entry point.

1148

</summary>

1149

</member>

1150

1151

1152

Marks a method as a custom action entry point.

1153

</summary>

1154

<param name="name">Name of the function to be exported,

1155

defaults to the name of this method</param>

1156

</member>

1157

1158

1159

Gets or sets the name of the custom action entrypoint. A null

1160

value defaults to the name of the method.

1161

</summary>

1162

<value>name of the custom action entrypoint, or null if none was specified</value>

1163

</member>

1164

1165

1166

Contains a collection of key-value pairs suitable for passing between

1167

immediate and deferred/rollback/commit custom actions.

1168

</summary>

1169

1170

Call the <see cref="M:Microsoft.Deployment.WindowsInstaller.CustomActionData.ToString"/> method to get a string

1171

suitable for storing in a property and reconstructing the custom action data later.

1172

</remarks>

1173

1174

1175

</member>

1176

1177

1178

"CustomActionData" literal property name.

1179

</summary>

1180

</member>

1181

1182

1183

Creates a new empty custom action data object.

1184

</summary>

1185

</member>

1186

1187

1188

Reconstructs a custom action data object from data that was previously

1189

persisted in a string.

1190

</summary>

1191

<param name="keyValueList">Previous output from <see cref="M:Microsoft.Deployment.WindowsInstaller.CustomActionData.ToString"/>.</param>

1192

</member>

1193

1194

1195

Adds a key and value to the data collection.

1196

</summary>

1197

<param name="key">Case-sensitive data key.</param>

1198

<param name="value">Data value (may be null).</param>

1199

<exception cref="T:System.ArgumentException">the key does not consist solely of letters,

1200

numbers, and the period, underscore, and space characters.</exception>

1201

</member>

1202

1203

1204

Adds a value to the data collection, using XML serialization to persist the object as a string.

1205

</summary>

1206

<param name="key">Case-sensitive data key.</param>

1207

<param name="value">Data value (may be null).</param>

1208

<exception cref="T:System.ArgumentException">the key does not consist solely of letters,

1209

numbers, and the period, underscore, and space characters.</exception>

1210

<exception cref="T:System.NotSupportedException">The value type does not support XML serialization.</exception>

1211

<exception cref="T:System.InvalidOperationException">The value could not be serialized.</exception>

1212

</member>

1213

1214

1215

Gets a value from the data collection, using XML serialization to load the object from a string.

1216

</summary>

1217

<param name="key">Case-sensitive data key.</param>

1218

<exception cref="T:System.InvalidOperationException">The value could not be deserialized.</exception>

1219

</member>

1220

1221

1222

Determines whether the data contains an item with the specified key.

1223

</summary>

1224

<param name="key">Case-sensitive data key.</param>

1225

<returns>true if the data contains an item with the key; otherwise, false</returns>

1226

</member>

1227

1228

1229

Removes the item with the specified key from the data.

1230

</summary>

1231

<param name="key">Case-sensitive data key.</param>

1232

<returns>true if the item was successfully removed from the data;

1233

false if an item with the specified key was not found</returns>

1234

</member>

1235

1236

1237

Gets the value with the specified key.

1238

</summary>

1239

<param name="key">Case-sensitive data key.</param>

1240

<param name="value">Value associated with the specified key, or

1241

null if an item with the specified key was not found</param>

1242

<returns>true if the data contains an item with the specified key; otherwise, false.</returns>

1243

</member>

1244

1245

1246

Adds an item with key and value to the data collection.

1247

</summary>

1248

<param name="item">Case-sensitive data key, with a data value that may be null.</param>

1249

<exception cref="T:System.ArgumentException">the key does not consist solely of letters,

1250

numbers, and the period, underscore, and space characters.</exception>

1251

</member>

1252

1253

1254

Removes all items from the data.

1255

</summary>

1256

</member>

1257

1258

1259

Determines whether the data contains a specified item.

1260

</summary>

1261

<param name="item">The data item to locate.</param>

1262

<returns>true if the data contains the item; otherwise, false</returns>

1263

</member>

1264

1265

1266

Copies the data to an array, starting at a particular array index.

1267

</summary>

1268

<param name="array">Destination array.</param>

1269

<param name="arrayIndex">Index in the array at which copying begins.</param>

1270

</member>

1271

1272

1273

Removes an item from the data.

1274

</summary>

1275

<param name="item">The item to remove.</param>

1276

<returns>true if the item was successfully removed from the data;

1277

false if the item was not found</returns>

1278

</member>

1279

1280

1281

Returns an enumerator that iterates through the collection.

1282

</summary>

1283

<returns>An enumerator that can be used to iterate through the collection.</returns>

1284

</member>

1285

1286

1287

Returns an enumerator that iterates through the collection.

1288

</summary>

1289

<returns>An enumerator that can be used to iterate through the collection.</returns>

1290

</member>

1291

1292

1293

Gets a string representation of the data suitable for persisting in a property.

1294

</summary>

1295

<returns>Data string in the form "Key1=Value1;Key2=Value2"</returns>

1296

</member>

1297

1298

1299

Ensures that a key contains valid characters.

1300

</summary>

1301

<param name="key">key to be validated</param>

1302

<exception cref="T:System.ArgumentException">the key does not consist solely of letters,

1303

numbers, and the period, underscore, and space characters.</exception>

1304

</member>

1305

1306

1307

Serializes a value into an XML string.

1308

</summary>

1309

<typeparam name="T">Type of the value.</typeparam>

1310

<param name="value">Value to be serialized.</param>

1311

<returns>Serialized value data as a string.</returns>

1312

</member>

1313

1314

1315

Deserializes a value from an XML string.

1316

</summary>

1317

<typeparam name="T">Expected type of the value.</typeparam>

1318

<param name="value">Serialized value data.</param>

1319

<returns>Deserialized value object.</returns>

1320

</member>

1321

1322

1323

Escapes a value string by doubling any data-separator (semicolon) characters.

1324

</summary>

1325

1326

<returns>Escaped value string</returns>

1327

</member>

1328

1329

1330

Unescapes a value string by undoubling any doubled data-separator (semicolon) characters.

1331

</summary>

1332

1333

<returns>Unescaped value string</returns>

1334

</member>

1335

1336

1337

Loads key-value pairs from a string into the data collection.

1338

</summary>

1339

<param name="keyValueList">key-value pair list of the form returned by <see cref="M:Microsoft.Deployment.WindowsInstaller.CustomActionData.ToString"/></param>

1340

</member>

1341

1342

1343

Gets a collection object containing all the keys of the data.

1344

</summary>

1345

</member>

1346

1347

1348

Gets a collection containing all the values of the data.

1349

</summary>

1350

</member>

1351

1352

1353

Gets or sets a data value with a specified key.

1354

</summary>

1355

<param name="key">Case-sensitive data key.</param>

1356

<exception cref="T:System.ArgumentException">the key does not consist solely of letters,

1357

numbers, and the period, underscore, and space characters.</exception>

1358

</member>

1359

1360

1361

Gets the number of items in the data.

1362

</summary>

1363

</member>

1364

1365

1366

Gets a value indicating whether the data is read-only.

1367

</summary>

1368

</member>

1369

1370

1371

Managed-code portion of the custom action proxy.

1372

</summary>

1373

</member>

1374

1375

1376

Invokes a managed custom action method.

1377

</summary>

1378

<param name="sessionHandle">Integer handle to the installer session.</param>

1379

<param name="entryPoint">Name of the custom action entrypoint. This must

1380

either map to an entrypoint definition in the <c>customActions</c>

1381

config section, or be an explicit entrypoint of the form:

1382

"AssemblyName!Namespace.Class.Method"</param>

1383

<param name="remotingDelegatePtr">Pointer to a delegate used to

1384

make remote API calls, if this custom action is running out-of-proc.</param>

1385

<returns>The value returned by the custom action method,

1386

or ERROR_INSTALL_FAILURE if the custom action could not be invoked.</returns>

1387

</member>

1388

1389

1390

Checks the "MMsiBreak" environment variable for any matching custom action names.

1391

</summary>

1392

<param name="names">List of names to search for in the environment

1393

variable string.</param>

1394

<returns>True if a match was found, else false.</returns>

1395

</member>

1396

1397

1398

Locates and parses an entrypoint mapping in CustomAction.config.

1399

</summary>

1400

<param name="session">Installer session handle, just used for logging.</param>

1401

<param name="entryPoint">Custom action entrypoint name: the key value

1402

in an item in the <c>customActions</c> section of the config file.</param>

1403

<param name="assemblyName">Returned display name of the assembly from

1404

the entrypoint mapping.</param>

1405

<param name="className">Returned class name of the entrypoint mapping.</param>

1406

<param name="methodName">Returned method name of the entrypoint mapping.</param>

1407

<returns>True if the entrypoint was found, false if not or if some error

1408

occurred.</returns>

1409

</member>

1410

1411

1412

Uses reflection to load the assembly and class and find the method.

1413

</summary>

1414

<param name="session">Installer session handle, just used for logging.</param>

1415

<param name="assemblyName">Display name of the assembly containing the

1416

custom action method.</param>

1417

<param name="className">Fully-qualified name of the class containing the

1418

custom action method.</param>

1419

<param name="methodName">Name of the custom action method.</param>

1420

<returns>The method, or null if not found.</returns>

1421

</member>

1422

1423

1424

Checks if a method has the right return and paramater types

1425

for a custom action, and that it is marked by a CustomActionAttribute.

1426

</summary>

1427

<param name="method">Method to be checked.</param>

1428

<returns>True if the method is a valid custom action, else false.</returns>

1429

</member>

1430

1431

1432

Accesses a Windows Installer database.

1433

</summary>

1434

1435

The <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.Commit"/> method must be called before the Database is closed to write out all

1436

persistent changes. If the Commit method is not called, the installer performs an implicit

1437

rollback upon object destruction.

1438

1439

The client can use the following procedure for data access:<list type="number">

1440

<item><description>Obtain a Database object using one of the Database constructors.</description></item>

1441

<item><description>Initiate a query using a SQL string by calling the <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.OpenView(System.String,System.Object[])"/>

1442

method of the Database.</description></item>

1443

<item><description>Set query parameters in a <see cref="T:Microsoft.Deployment.WindowsInstaller.Record"/> and execute the database

1444

query by calling the <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Execute(Microsoft.Deployment.WindowsInstaller.Record)"/> method of the <see cref="T:Microsoft.Deployment.WindowsInstaller.View"/>. This

1445

produces a result that can be fetched or updated.</description></item>

1446

<item><description>Call the <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/> method of the View repeatedly to return

1447

Records.</description></item>

1448

<item><description>Update database rows of a Record object obtained by the Fetch method using

1449

one of the <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> methods of the View.</description></item>

1450

<item><description>Release the query and any unfetched records by calling the <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>

1451

method of the View.</description></item>

1452

<item><description>Persist any database updates by calling the Commit method of the Database.

1453

</description></item>

1454

</list>

1455

</remarks>

1456

</member>

1457

1458

1459

Base class for Windows Installer handle types (Database, View, Record, SummaryInfo).

1460

</summary>

1461

1462

These classes implement the <see cref="T:System.IDisposable"/> interface, because they

1463

hold unmanaged resources (MSI handles) that should be properly disposed

1464

when no longer needed.

1465

</remarks>

1466

</member>

1467

1468

1469

Constructs a handle object from a native integer handle.

1470

</summary>

1471

<param name="handle">Native integer handle.</param>

1472

<param name="ownsHandle">true to close the handle when this object is disposed or finalized</param>

1473

</member>

1474

1475

1476

Closes the handle. After closing a handle, further method calls may throw an <see cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException"/>.

1477

</summary>

1478

1479

The finalizer of this class will NOT close the handle if it is still open,

1480

because finalization can run on a separate thread from the application,

1481

resulting in potential problems if handles are closed from that thread.

1482

It is best that the handle be closed manually as soon as it is no longer needed,

1483

as leaving lots of unused handles open can degrade performance.

1484

1485

Win32 MSI API:

1486

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiclosehandle.asp">MsiCloseHandle</a>

1487

</remarks>

1488

1489

</member>

1490

1491

1492

Closes the handle. After closing a handle, further method calls may throw an <see cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException"/>.

1493

</summary>

1494

1495

The finalizer of this class will NOT close the handle if it is still open,

1496

because finalization can run on a separate thread from the application,

1497

resulting in potential problems if handles are closed from that thread.

1498

It is best that the handle be closed manually as soon as it is no longer needed,

1499

as leaving lots of unused handles open can degrade performance.

1500

1501

This method is merely an alias for the <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Dispose"/> method.

1502

1503

Win32 MSI API:

1504

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiclosehandle.asp">MsiCloseHandle</a>

1505

</remarks>

1506

</member>

1507

1508

1509

Tests whether this handle object is equal to another handle object. Two handle objects are equal

1510

if their types are the same and their native integer handles are the same.

1511

</summary>

1512

<param name="obj">The handle object to compare with the current handle object.</param>

1513

<returns>true if the specified handle object is equal to the current handle object; otherwise false</returns>

1514

</member>

1515

1516

1517

Gets a hash value for the handle object.

1518

</summary>

1519

<returns>A hash code for the handle object.</returns>

1520

1521

The hash code is derived from the native integer handle.

1522

</remarks>

1523

</member>

1524

1525

1526

Closes the handle. After closing a handle, further method calls may throw an <see cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException"/>.

1527

</summary>

1528

<param name="disposing">If true, the method has been called directly or indirectly by a user's code,

1529

so managed and unmanaged resources will be disposed. If false, the method has been called by the

1530

runtime from inside the finalizer, and only unmanaged resources will be disposed.</param>

1531

</member>

1532

1533

1534

Gets the native integer handle.

1535

</summary>

1536

</member>

1537

1538

1539

Checks if the handle is closed. When closed, method calls on the handle object may throw an <see cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException"/>.

1540

</summary>

1541

</member>

1542

1543

1544

Gets an object that can be used internally for safe syncronization.

1545

</summary>

1546

</member>

1547

1548

1549

Opens an existing database in read-only mode.

1550

</summary>

1551

<param name="filePath">Path to the database file.</param>

1552

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the database could not be created/opened</exception>

1553

1554

Because this constructor initiates database access, it cannot be used with a

1555

running installation.

1556

1557

The Database object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

1558

It is best that the handle be closed manually as soon as it is no longer

1559

needed, as leaving lots of unused handles open can degrade performance.

1560

1561

Win32 MSI API:

1562

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopendatabase.asp">MsiOpenDatabase</a>

1563

</remarks>

1564

</member>

1565

1566

1567

Opens an existing database with another database as output.

1568

</summary>

1569

<param name="filePath">Path to the database to be read.</param>

1570

<param name="outputPath">Open mode for the database</param>

1571

<returns>Database object representing the created or opened database</returns>

1572

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the database could not be created/opened</exception>

1573

1574

When a database is opened as the output of another database, the summary information stream

1575

of the output database is actually a read-only mirror of the original database and thus cannot

1576

be changed. Additionally, it is not persisted with the database. To create or modify the

1577

summary information for the output database it must be closed and re-opened.

1578

1579

The Database object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

1580

It is best that the handle be closed manually as soon as it is no longer

1581

needed, as leaving lots of unused handles open can degrade performance.

1582

1583

The database is opened in <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.CreateDirect"/> mode, and will be

1584

automatically commited when it is closed.

1585

1586

Win32 MSI API:

1587

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopendatabase.asp">MsiOpenDatabase</a>

1588

</remarks>

1589

</member>

1590

1591

1592

Opens an existing database or creates a new one.

1593

</summary>

1594

<param name="filePath">Path to the database file. If an empty string

1595

is supplied, a temporary database is created that is not persisted.</param>

1596

<param name="mode">Open mode for the database</param>

1597

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the database could not be created/opened</exception>

1598

1599

Because this constructor initiates database access, it cannot be used with a

1600

running installation.

1601

1602

The database object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

1603

The finalizer will close the handle if it is still open, however due to the nondeterministic

1604

nature of finalization it is best that the handle be closed manually as soon as it is no

1605

longer needed, as leaving lots of unused handles open can degrade performance.

1606

1607

A database opened in <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.CreateDirect"/> or

1608

<see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.Direct"/> mode will be automatically commited when it is

1609

closed. However a database opened in <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.Create"/> or

1610

<see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.Transact"/> mode must have the <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.Commit"/> method

1611

called before it is closed, otherwise no changes will be persisted.

1612

1613

Win32 MSI API:

1614

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopendatabase.asp">MsiOpenDatabase</a>

1615

</remarks>

1616

</member>

1617

1618

1619

Creates a new database from an MSI handle.

1620

</summary>

1621

<param name="handle">Native MSI database handle.</param>

1622

<param name="ownsHandle">True if the handle should be closed

1623

when the database object is disposed</param>

1624

<param name="filePath">Path of the database file, if known</param>

1625

<param name="openMode">Mode the handle was originally opened in</param>

1626

</member>

1627

1628

1629

Creates a new Database object from an integer database handle.

1630

</summary>

1631

1632

This method is only provided for interop purposes. A Database object

1633

should normally be obtained from <see cref="P:Microsoft.Deployment.WindowsInstaller.Session.Database"/> or

1634

a public Database constructor.

1635

</remarks>

1636

<param name="handle">Integer database handle</param>

1637

<param name="ownsHandle">true to close the handle when this object is disposed</param>

1638

</member>

1639

1640

1641

Schedules a file or directory for deletion after the database handle is closed.

1642

</summary>

1643

<param name="path">File or directory path to be deleted. All files and subdirectories

1644

under a directory are deleted.</param>

1645

1646

Once an item is scheduled, it cannot be unscheduled.

1647

1648

The items cannot be deleted if the Database object is auto-disposed by the

1649

garbage collector; the handle must be explicitly closed.

1650

1651

Files which are read-only or otherwise locked cannot be deleted,

1652

but they will not cause an exception to be thrown.

1653

</remarks>

1654

</member>

1655

1656

1657

Merges another database with this database.

1658

</summary>

1659

<param name="otherDatabase">The database to be merged into this database</param>

1660

<param name="errorTable">Optional name of table to contain the names of the tables containing

1661

merge conflicts, the number of conflicting rows within the table, and a reference to the table

1662

with the merge conflict.</param>

1663

<exception cref="T:Microsoft.Deployment.WindowsInstaller.MergeException">merge failed due to a schema difference or data conflict</exception>

1664

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1665

1666

Merge does not copy over embedded cabinet files or embedded transforms from the

1667

reference database into the target database. Embedded data streams that are listed in the

1668

Binary table or Icon table are copied from the reference database to the target database.

1669

Storage embedded in the reference database are not copied to the target database.

1670

1671

The Merge method merges the data of two databases. These databases must have the same

1672

codepage. The merge fails if any tables or rows in the databases conflict. A conflict exists

1673

if the data in any row in the first database differs from the data in the corresponding row

1674

of the second database. Corresponding rows are in the same table of both databases and have

1675

the same primary key in both databases. The tables of non-conflicting databases must have

1676

the same number of primary keys, same number of columns, same column types, same column names,

1677

and the same data in rows with identical primary keys. Temporary columns however don't matter

1678

in the column count and corresponding tables can have a different number of temporary columns

1679

without creating conflict as long as the persistent columns match.

1680

1681

If the number, type, or name of columns in corresponding tables are different, the

1682

schema of the two databases are incompatible and the installer will stop processing tables

1683

and the merge fails. The installer checks that the two databases have the same schema before

1684

checking for row merge conflicts. If the schemas are incompatible, the databases have be

1685

modified.

1686

1687

If the data in particular rows differ, this is a row merge conflict, the merge fails

1688

and creates a new table with the specified name. The first column of this table is the name

1689

of the table having the conflict. The second column gives the number of rows in the table

1690

having the conflict.

1691

1692

Win32 MSI API:

1693

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabasemerge.asp">MsiDatabaseMerge</a>

1694

</remarks>

1695

</member>

1696

1697

1698

Merges another database with this database.

1699

</summary>

1700

<param name="otherDatabase">The database to be merged into this database</param>

1701

<exception cref="T:Microsoft.Deployment.WindowsInstaller.MergeException">merge failed due to a schema difference or data conflict</exception>

1702

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1703

1704

MsiDatabaseMerge does not copy over embedded cabinet files or embedded transforms from

1705

the reference database into the target database. Embedded data streams that are listed in

1706

the Binary table or Icon table are copied from the reference database to the target database.

1707

Storage embedded in the reference database are not copied to the target database.

1708

1709

The Merge method merges the data of two databases. These databases must have the same

1710

codepage. The merge fails if any tables or rows in the databases conflict. A conflict exists

1711

if the data in any row in the first database differs from the data in the corresponding row

1712

of the second database. Corresponding rows are in the same table of both databases and have

1713

the same primary key in both databases. The tables of non-conflicting databases must have

1714

the same number of primary keys, same number of columns, same column types, same column names,

1715

and the same data in rows with identical primary keys. Temporary columns however don't matter

1716

in the column count and corresponding tables can have a different number of temporary columns

1717

without creating conflict as long as the persistent columns match.

1718

1719

If the number, type, or name of columns in corresponding tables are different, the

1720

schema of the two databases are incompatible and the installer will stop processing tables

1721

and the merge fails. The installer checks that the two databases have the same schema before

1722

checking for row merge conflicts. If the schemas are incompatible, the databases have be

1723

modified.

1724

1725

Win32 MSI API:

1726

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabasemerge.asp">MsiDatabaseMerge</a>

1727

</remarks>

1728

</member>

1729

1730

1731

Checks whether a table exists and is persistent in the database.

1732

</summary>

1733

<param name="table">The table to the checked</param>

1734

<returns>true if the table exists and is persistent in the database; false otherwise</returns>

1735

<exception cref="T:System.ArgumentException">the table is unknown</exception>

1736

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1737

1738

To check whether a table exists regardless of persistence,

1739

use <see cref="M:Microsoft.Deployment.WindowsInstaller.TableCollection.Contains(System.String)"/>.

1740

1741

Win32 MSI API:

1742

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseistablepersistent.asp">MsiDatabaseIsTablePersistent</a>

1743

</remarks>

1744

</member>

1745

1746

1747

Checks whether a table contains a persistent column with a given name.

1748

</summary>

1749

<param name="table">The table to the checked</param>

1750

<param name="column">The name of the column to be checked</param>

1751

<returns>true if the column exists in the table; false if the column is temporary or does not exist.</returns>

1752

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1753

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1754

1755

To check whether a column exists regardless of persistence,

1756

use <see cref="M:Microsoft.Deployment.WindowsInstaller.ColumnCollection.Contains(System.String)"/>.

1757

</remarks>

1758

</member>

1759

1760

1761

Gets the count of all rows in the table.

1762

</summary>

1763

<param name="table">Name of the table whose rows are to be counted</param>

1764

<returns>The count of all rows in the table</returns>

1765

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1766

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1767

</member>

1768

1769

1770

Gets the count of all rows in the table that satisfy a given condition.

1771

</summary>

1772

<param name="table">Name of the table whose rows are to be counted</param>

1773

<param name="where">Conditional expression, such as could be placed on the end of a SQL WHERE clause</param>

1774

<returns>The count of all rows in the table satisfying the condition</returns>

1775

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL WHERE syntax is invalid</exception>

1776

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1777

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1778

</member>

1779

1780

1781

Finalizes the persistent form of the database. All persistent data is written

1782

to the writeable database, and no temporary columns or rows are written.

1783

</summary>

1784

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1785

1786

For a database open in <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.ReadOnly"/> mode, this method has no effect.

1787

1788

For a database open in <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.CreateDirect"/> or <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.Direct"/>

1789

mode, it is not necessary to call this method because the database will be automatically committed

1790

when it is closed. However this method may be called at any time to persist the current state of tables

1791

loaded into memory.

1792

1793

For a database open in <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.Create"/> or <see cref="F:Microsoft.Deployment.WindowsInstaller.DatabaseOpenMode.Transact"/>

1794

mode, no changes will be persisted until this method is called. If the database object is closed without

1795

calling this method, the database file remains unmodified.

1796

1797

Win32 MSI API:

1798

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabasecommit.asp">MsiDatabaseCommit</a>

1799

</remarks>

1800

</member>

1801

1802

1803

Copies the structure and data from a specified table to a text archive file.

1804

</summary>

1805

<param name="table">Name of the table to be exported</param>

1806

<param name="exportFilePath">Path to the file to be created</param>

1807

<exception cref="T:System.IO.FileNotFoundException">the file path is invalid</exception>

1808

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1809

1810

Win32 MSI API:

1811

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseexport.asp">MsiDatabaseExport</a>

1812

</remarks>

1813

</member>

1814

1815

1816

Imports a database table from a text archive file, dropping any existing table.

1817

</summary>

1818

<param name="importFilePath">Path to the file to be imported.

1819

The table name is specified within the file.</param>

1820

<exception cref="T:System.IO.FileNotFoundException">the file path is invalid</exception>

1821

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1822

1823

Win32 MSI API:

1824

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseimport.asp">MsiDatabaseImport</a>

1825

</remarks>

1826

</member>

1827

1828

1829

Exports all database tables, streams, and summary information to archive files.

1830

</summary>

1831

<param name="directoryPath">Path to the directory where archive files will be created</param>

1832

<exception cref="T:System.IO.FileNotFoundException">the directory path is invalid</exception>

1833

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1834

1835

The directory will be created if it does not already exist.

1836

1837

Win32 MSI API:

1838

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseexport.asp">MsiDatabaseExport</a>

1839

</remarks>

1840

</member>

1841

1842

1843

Imports all database tables, streams, and summary information from archive files.

1844

</summary>

1845

<param name="directoryPath">Path to the directory from which archive files will be imported</param>

1846

<exception cref="T:System.IO.FileNotFoundException">the directory path is invalid</exception>

1847

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1848

1849

Win32 MSI API:

1850

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseimport.asp">MsiDatabaseImport</a>

1851

</remarks>

1852

</member>

1853

1854

1855

Creates a new record object with the requested number of fields.

1856

</summary>

1857

<param name="fieldCount">Required number of fields, which may be 0.

1858

The maximum number of fields in a record is limited to 65535.</param>

1859

<returns>A new record object that can be used with the database.</returns>

1860

1861

This method is equivalent to directly calling the <see cref="T:Microsoft.Deployment.WindowsInstaller.Record"/>

1862

constructor in all cases outside of a custom action context. When in a

1863

custom action session, this method allows creation of a record that can

1864

work with a database other than the session database.

1865

1866

The Record object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

1867

It is best that the handle be closed manually as soon as it is no longer

1868

needed, as leaving lots of unused handles open can degrade performance.

1869

1870

Win32 MSI API:

1871

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msicreaterecord.asp">MsiCreateRecord</a>

1872

</remarks>

1873

</member>

1874

1875

1876

Returns the file path of this database, or the handle value if a file path was not specified.

1877

</summary>

1878

</member>

1879

1880

1881

Closes the database handle. After closing a handle, further method calls may throw <see cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException"/>.

1882

</summary>

1883

<param name="disposing">If true, the method has been called directly or

1884

indirectly by a user's code, so managed and unmanaged resources will be

1885

disposed. If false, only unmanaged resources will be disposed.</param>

1886

</member>

1887

1888

1889

Gets a View object representing the query specified by a SQL string.

1890

</summary>

1891

<param name="sqlFormat">SQL query string, which may contain format items</param>

1892

<param name="args">Zero or more objects to format</param>

1893

<returns>A View object representing the query specified by a SQL string</returns>

1894

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

1895

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1896

1897

The <paramref name="sqlFormat"/> parameter is formatted using <see cref="M:System.String.Format(System.String,System.Object[])"/>.

1898

1899

The View object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

1900

It is best that the handle be closed manually as soon as it is no longer

1901

needed, as leaving lots of unused handles open can degrade performance.

1902

1903

Win32 MSI API:

1904

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>

1905

</remarks>

1906

</member>

1907

1908

1909

Executes the query specified by a SQL string. The query may not be a SELECT statement.

1910

</summary>

1911

<param name="sqlFormat">SQL query string, which may contain format items</param>

1912

<param name="args">Zero or more objects to format</param>

1913

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

1914

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1915

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1916

1917

The <paramref name="sqlFormat"/> parameter is formatted using

1918

<see cref="M:System.String.Format(System.String,System.Object[])"/>.

1919

1920

Win32 MSI APIs:

1921

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

1922

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>

1923

</remarks>

1924

</member>

1925

1926

1927

Executes the query specified by a SQL string. The query may not be a SELECT statement.

1928

</summary>

1929

<param name="sql">SQL query string</param>

1930

<param name="record">Optional Record object containing the values that replace

1931

the parameter tokens (?) in the SQL query.</param>

1932

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

1933

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1934

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1935

1936

Win32 MSI APIs:

1937

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

1938

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>

1939

</remarks>

1940

</member>

1941

1942

1943

Executes the specified SQL SELECT query and returns all results.

1944

</summary>

1945

<param name="sqlFormat">SQL query string, which may contain format items</param>

1946

<param name="args">Zero or more objects to format</param>

1947

<returns>All results combined into an array</returns>

1948

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

1949

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1950

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1951

1952

The <paramref name="sqlFormat"/> parameter is formatted using

1953

<see cref="M:System.String.Format(System.String,System.Object[])"/>.

1954

1955

Multiple rows columns will be collapsed into a single one-dimensional list.

1956

1957

Win32 MSI APIs:

1958

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

1959

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

1960

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

1961

</remarks>

1962

</member>

1963

1964

1965

Executes the specified SQL SELECT query and returns all results.

1966

</summary>

1967

<param name="sql">SQL SELECT query string</param>

1968

<param name="record">Optional Record object containing the values that replace

1969

the parameter tokens (?) in the SQL query.</param>

1970

<returns>All results combined into an array</returns>

1971

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

1972

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1973

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1974

1975

Multiple rows columns will be collapsed into a single one-dimensional list.

1976

1977

Win32 MSI APIs:

1978

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

1979

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

1980

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

1981

</remarks>

1982

</member>

1983

1984

1985

Executes the specified SQL SELECT query and returns all results as integers.

1986

</summary>

1987

<param name="sqlFormat">SQL query string, which may contain format items</param>

1988

<param name="args">Zero or more objects to format</param>

1989

<returns>All results combined into an array</returns>

1990

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

1991

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

1992

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

1993

1994

The <paramref name="sqlFormat"/> parameter is formatted using

1995

<see cref="M:System.String.Format(System.String,System.Object[])"/>.

1996

1997

Multiple rows columns will be collapsed into a single one-dimensional list.

1998

1999

Win32 MSI APIs:

2000

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

2001

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

2002

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

2003

</remarks>

2004

</member>

2005

2006

2007

Executes the specified SQL SELECT query and returns all results as integers.

2008

</summary>

2009

<param name="sql">SQL SELECT query string</param>

2010

<param name="record">Optional Record object containing the values that replace

2011

the parameter tokens (?) in the SQL query.</param>

2012

<returns>All results combined into an array</returns>

2013

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

2014

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

2015

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2016

2017

Multiple rows columns will be collapsed into a single one-dimensional list.

2018

2019

Win32 MSI APIs:

2020

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

2021

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

2022

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

2023

</remarks>

2024

</member>

2025

2026

2027

Executes the specified SQL SELECT query and returns all results as strings.

2028

</summary>

2029

<param name="sqlFormat">SQL query string, which may contain format items</param>

2030

<param name="args">Zero or more objects to format</param>

2031

<returns>All results combined into an array</returns>

2032

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

2033

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

2034

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2035

2036

The <paramref name="sqlFormat"/> parameter is formatted using

2037

<see cref="M:System.String.Format(System.String,System.Object[])"/>.

2038

2039

Multiple rows columns will be collapsed into a single on-dimensional list.

2040

2041

Win32 MSI APIs:

2042

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

2043

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

2044

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

2045

</remarks>

2046

</member>

2047

2048

2049

Executes the specified SQL SELECT query and returns all results as strings.

2050

</summary>

2051

<param name="sql">SQL SELECT query string</param>

2052

<param name="record">Optional Record object containing the values that replace

2053

the parameter tokens (?) in the SQL query.</param>

2054

<returns>All results combined into an array</returns>

2055

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

2056

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

2057

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2058

2059

Multiple rows columns will be collapsed into a single on-dimensional list.

2060

2061

Win32 MSI APIs:

2062

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

2063

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

2064

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

2065

</remarks>

2066

</member>

2067

2068

2069

Executes the specified SQL SELECT query and returns a single result.

2070

</summary>

2071

<param name="sqlFormat">SQL query string, which may contain format items</param>

2072

<param name="args">Zero or more objects to format</param>

2073

<returns>First field of the first result</returns>

2074

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

2075

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed

2076

or the query returned 0 results</exception>

2077

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2078

2079

The <paramref name="sqlFormat"/> parameter is formatted using

2080

<see cref="M:System.String.Format(System.String,System.Object[])"/>.

2081

2082

Win32 MSI APIs:

2083

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

2084

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

2085

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

2086

</remarks>

2087

</member>

2088

2089

2090

Executes the specified SQL SELECT query and returns a single result.

2091

</summary>

2092

<param name="sql">SQL SELECT query string</param>

2093

<param name="record">Optional Record object containing the values that replace

2094

the parameter tokens (?) in the SQL query.</param>

2095

<returns>First field of the first result</returns>

2096

<exception cref="T:Microsoft.Deployment.WindowsInstaller.BadQuerySyntaxException">the SQL syntax is invalid</exception>

2097

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed

2098

or the query returned 0 results</exception>

2099

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2100

2101

Win32 MSI APIs:

2102

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseopenview.asp">MsiDatabaseOpenView</a>,

2103

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>,

2104

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

2105

</remarks>

2106

</member>

2107

2108

2109

Creates a transform that, when applied to the object database, results in the reference database.

2110

</summary>

2111

<param name="referenceDatabase">Database that does not include the changes</param>

2112

<param name="transformFile">Name of the generated transform file, or null to only

2113

check whether or not the two database are identical</param>

2114

<returns>true if a transform is generated, or false if a transform is not generated

2115

because there are no differences between the two databases.</returns>

2116

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the transform could not be generated</exception>

2117

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">a Database handle is invalid</exception>

2118

2119

A transform can add non-primary key columns to the end of a table. A transform cannot

2120

be created that adds primary key columns to a table. A transform cannot be created that

2121

changes the order, names, or definitions of columns.

2122

2123

If the transform is to be applied during an installation you must use the

2124

<see cref="M:Microsoft.Deployment.WindowsInstaller.Database.CreateTransformSummaryInfo(Microsoft.Deployment.WindowsInstaller.Database,System.String,Microsoft.Deployment.WindowsInstaller.TransformErrors,Microsoft.Deployment.WindowsInstaller.TransformValidations)"/> method to populate the

2125

summary information stream.

2126

2127

Win32 MSI API:

2128

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabasegeneratetransform.asp">MsiDatabaseGenerateTransform</a>

2129

</remarks>

2130

</member>

2131

2132

2133

Creates and populates the summary information stream of an existing transform file, and

2134

fills in the properties with the base and reference ProductCode and ProductVersion.

2135

</summary>

2136

<param name="referenceDatabase">Database that does not include the changes</param>

2137

<param name="transformFile">Name of the generated transform file</param>

2138

<param name="errors">Error conditions that should be suppressed

2139

when the transform is applied</param>

2140

<param name="validations">Defines which properties should be validated

2141

to verify that this transform can be applied to a database.</param>

2142

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the transform summary info could not be

2143

generated</exception>

2144

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">a Database handle is invalid</exception>

2145

2146

Win32 MSI API:

2147

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msicreatetransformsummaryinfo.asp">MsiCreateTransformSummaryInfo</a>

2148

</remarks>

2149

</member>

2150

2151

2152

Apply a transform to the database, recording the changes in the "_TransformView" table.

2153

</summary>

2154

<param name="transformFile">Path to the transform file</param>

2155

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the transform could not be applied</exception>

2156

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2157

2158

Win32 MSI API:

2159

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseapplytransform.asp">MsiDatabaseApplyTransform</a>

2160

</remarks>

2161

</member>

2162

2163

2164

Apply a transform to the database, suppressing any error conditions

2165

specified by the transform's summary information.

2166

</summary>

2167

<param name="transformFile">Path to the transform file</param>

2168

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the transform could not be applied</exception>

2169

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2170

2171

Win32 MSI API:

2172

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseapplytransform.asp">MsiDatabaseApplyTransform</a>

2173

</remarks>

2174

</member>

2175

2176

2177

Apply a transform to the database, specifying error conditions to suppress.

2178

</summary>

2179

<param name="transformFile">Path to the transform file</param>

2180

<param name="errorConditionsToSuppress">Error conditions that are to be suppressed</param>

2181

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the transform could not be applied</exception>

2182

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2183

2184

Win32 MSI API:

2185

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidatabaseapplytransform.asp">MsiDatabaseApplyTransform</a>

2186

</remarks>

2187

</member>

2188

2189

2190

Checks whether a transform is valid for this Database, according to its validation data and flags.

2191

</summary>

2192

<param name="transformFile">Path to the transform file</param>

2193

<returns>true if the transform can be validly applied to this Database; false otherwise</returns>

2194

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the transform could not be applied</exception>

2195

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2196

</member>

2197

2198

2199

Checks whether a transform is valid for this Database, according to its SummaryInfo data.

2200

</summary>

2201

<param name="transformSummaryInfo">SummaryInfo data of a transform file</param>

2202

<returns>true if the transform can be validly applied to this Database; false otherwise</returns>

2203

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">error processing summary info</exception>

2204

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database or SummaryInfo handle is invalid</exception>

2205

</member>

2206

2207

2208

Gets the file path the Database was originally opened from, or null if not known.

2209

</summary>

2210

</member>

2211

2212

2213

Gets the open mode for the database.

2214

</summary>

2215

</member>

2216

2217

2218

Gets a boolean value indicating whether this database was opened in read-only mode.

2219

</summary>

2220

2221

Win32 MSI API:

2222

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetdatabasestate.asp">MsiGetDatabaseState</a>

2223

</remarks>

2224

</member>

2225

2226

2227

Gets the collection of tables in the Database.

2228

</summary>

2229

</member>

2230

2231

2232

Gets or sets the code page of the Database.

2233

</summary>

2234

<exception cref="T:System.IO.IOException">error exporting/importing the codepage data</exception>

2235

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2236

2237

Getting or setting the code page is a slow operation because it involves an export or import

2238

of the codepage data to/from a temporary file.

2239

</remarks>

2240

</member>

2241

2242

2243

Gets the SummaryInfo object for this database that can be used to examine and modify properties

2244

to the summary information stream.

2245

</summary>

2246

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Database handle is invalid</exception>

2247

2248

The object returned from this property does not need to be explicitly persisted or closed.

2249

Any modifications will be automatically saved when the database is committed.

2250

2251

Win32 MSI API:

2252

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetsummaryinformation.asp">MsiGetSummaryInformation</a>

2253

</remarks>

2254

</member>

2255

2256

2257

Managed-code portion of the embedded UI proxy.

2258

</summary>

2259

</member>

2260

2261

2262

Initializes managed embedded UI by loading the UI class and invoking its Initialize method.

2263

</summary>

2264

<param name="sessionHandle">Integer handle to the installer session.</param>

2265

<param name="uiClass">Name of the class that implements the embedded UI. This must

2266

be of the form: "AssemblyName!Namespace.Class"</param>

2267

<param name="internalUILevel">On entry, contains the current UI level for the installation. After this

2268

method returns, the installer resets the UI level to the returned value of this parameter.</param>

2269

<returns>0 if the embedded UI was successfully loaded and initialized,

2270

ERROR_INSTALL_USEREXIT if the user canceled the installation during initialization,

2271

or ERROR_INSTALL_FAILURE if the embedded UI could not be initialized.</returns>

2272

2273

Due to interop limitations, the successful resulting UILevel is actually returned

2274

as the high-word of the return value instead of via a ref parameter.

2275

</remarks>

2276

</member>

2277

2278

2279

Passes a progress message to the UI class.

2280

</summary>

2281

<param name="messageType">Installer message type and message box options.</param>

2282

<param name="recordHandle">Handle to a record containing message data.</param>

2283

<returns>Return value returned by the UI class.</returns>

2284

</member>

2285

2286

2287

Passes a shutdown message to the UI class.

2288

</summary>

2289

</member>

2290

2291

2292

Instantiates a UI class from a given assembly and class name.

2293

</summary>

2294

<param name="session">Installer session, for logging.</param>

2295

<param name="uiClass">Name of the class that implements the embedded UI. This must

2296

be of the form: "AssemblyName!Namespace.Class"</param>

2297

<returns>Interface on the UI class for handling UI messages.</returns>

2298

</member>

2299

2300

2301

Specifies a return status value for custom actions.

2302

</summary>

2303

</member>

2304

2305

<summary>Action completed successfully.</summary>

2306

</member>

2307

2308

<summary>Skip remaining actions, not an error.</summary>

2309

</member>

2310

2311

<summary>User terminated prematurely.</summary>

2312

</member>

2313

2314

<summary>Unrecoverable error or unhandled exception occurred.</summary>

2315

</member>

2316

2317

<summary>Action not executed.</summary>

2318

</member>

2319

2320

2321

Specifies the open mode for a <see cref="T:Microsoft.Deployment.WindowsInstaller.Database"/>.

2322

</summary>

2323

</member>

2324

2325

<summary>Open a database read-only, no persistent changes.</summary>

2326

</member>

2327

2328

<summary>Open a database read/write in transaction mode.</summary>

2329

</member>

2330

2331

<summary>Open a database direct read/write without transaction.</summary>

2332

</member>

2333

2334

<summary>Create a new database, transact mode read/write.</summary>

2335

</member>

2336

2337

<summary>Create a new database, direct mode read/write.</summary>

2338

</member>

2339

2340

2341

Log modes available for <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.EnableLog(Microsoft.Deployment.WindowsInstaller.InstallLogModes,System.String)"/>

2342

and <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetExternalUI(Microsoft.Deployment.WindowsInstaller.ExternalUIHandler,Microsoft.Deployment.WindowsInstaller.InstallLogModes)"/>.

2343

</summary>

2344

</member>

2345

2346

<summary>Disable logging.</summary>

2347

</member>

2348

2349

<summary>Log out of memory or fatal exit information.</summary>

2350

</member>

2351

2352

<summary>Log error messages.</summary>

2353

</member>

2354

2355

<summary>Log warning messages.</summary>

2356

</member>

2357

2358

<summary>Log user requests.</summary>

2359

</member>

2360

2361

<summary>Log status messages that are not displayed.</summary>

2362

</member>

2363

2364

<summary>Log request to determine a valid source location.</summary>

2365

</member>

2366

2367

<summary>Log insufficient disk space error.</summary>

2368

</member>

2369

2370

<summary>Log the start of installation actions.</summary>

2371

</member>

2372

2373

<summary>Log the data record for installation actions.</summary>

2374

</member>

2375

2376

<summary>Log parameters for user-interface initialization.</summary>

2377

</member>

2378

2379

<summary>Log the property values at termination.</summary>

2380

</member>

2381

2382

2383

Sends large amounts of information to log file not generally useful to users.

2384

May be used for support.

2385

</summary>

2386

</member>

2387

2388

2389

Log extra debugging information.

2390

</summary>

2391

</member>

2392

2393

2394

Log only on error.

2395

</summary>

2396

</member>

2397

2398

2399

Log progress bar information. This message includes information on units so far and total number

2400

of units. See <see cref="M:Microsoft.Deployment.WindowsInstaller.Session.Message(Microsoft.Deployment.WindowsInstaller.InstallMessage,Microsoft.Deployment.WindowsInstaller.Record)"/> for an explanation of the message format. This message

2401

is only sent to an external user interface and is not logged.

2402

</summary>

2403

</member>

2404

2405

2406

If this is not a quiet installation, then the basic UI has been initialized. If this is a full

2407

UI installation, the Full UI is not yet initialized. This message is only sent to an external

2408

user interface and is not logged.

2409

</summary>

2410

</member>

2411

2412

2413

If a full UI is being used, the full UI has ended. If this is not a quiet installation, the basic

2414

UI has not yet ended. This message is only sent to an external user interface and is not logged.

2415

</summary>

2416

</member>

2417

2418

2419

Sent prior to display of the Full UI dialog. This message is only sent to an external user

2420

interface and is not logged.

2421

</summary>

2422

</member>

2423

2424

2425

List of files in use that need to be replaced.

2426

</summary>

2427

</member>

2428

2429

2430

[MSI 4.0] List of apps that the user can request Restart Manager to shut down and restart.

2431

</summary>

2432

</member>

2433

2434

2435

Type of message to be processed by <see cref="M:Microsoft.Deployment.WindowsInstaller.Session.Message(Microsoft.Deployment.WindowsInstaller.InstallMessage,Microsoft.Deployment.WindowsInstaller.Record)"/>,

2436

<see cref="T:Microsoft.Deployment.WindowsInstaller.ExternalUIHandler"/>, or <see cref="T:Microsoft.Deployment.WindowsInstaller.ExternalUIRecordHandler"/>.

2437

</summary>

2438

</member>

2439

2440

<summary>Premature termination, possibly fatal OOM.</summary>

2441

</member>

2442

2443

<summary>Formatted error message.</summary>

2444

</member>

2445

2446

<summary>Formatted warning message.</summary>

2447

</member>

2448

2449

<summary>User request message.</summary>

2450

</member>

2451

2452

<summary>Informative message for log.</summary>

2453

</member>

2454

2455

<summary>List of files in use that need to be replaced.</summary>

2456

</member>

2457

2458

<summary>Request to determine a valid source location.</summary>

2459

</member>

2460

2461

<summary>Insufficient disk space message.</summary>

2462

</member>

2463

2464

<summary>Start of action: action name & description.</summary>

2465

</member>

2466

2467

<summary>Formatted data associated with individual action item.</summary>

2468

</member>

2469

2470

<summary>Progress gauge info: units so far, total.</summary>

2471

</member>

2472

2473

<summary>Product info for dialog: language Id, dialog caption.</summary>

2474

</member>

2475

2476

<summary>Sent prior to UI initialization, no string data.</summary>

2477

</member>

2478

2479

<summary>Sent after UI termination, no string data.</summary>

2480

</member>

2481

2482

<summary>Sent prior to display or authored dialog or wizard.</summary>

2483

</member>

2484

2485

<summary>[MSI 4.0] List of apps that the user can request Restart Manager to shut down and restart.</summary>

2486

</member>

2487

2488

<summary>[MSI 4.5] Sent prior to install of a product.</summary>

2489

</member>

2490

2491

<summary>[MSI 4.5] Sent after install of a product.</summary>

2492

</member>

2493

2494

2495

Specifies the install mode for <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.ProvideComponent(System.String,System.String,System.String,Microsoft.Deployment.WindowsInstaller.InstallMode)"/> or <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.ProvideQualifiedComponent(System.String,System.String,Microsoft.Deployment.WindowsInstaller.InstallMode,System.String)"/>.

2496

</summary>

2497

</member>

2498

2499

<summary>Provide the component only if the feature's installation state is <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallState.Local"/>.</summary>

2500

</member>

2501

2502

<summary>Only check that the component is registered, without verifying that the key file of the component exists.</summary>

2503

</member>

2504

2505

<summary>Provide the component only if the feature exists.</summary>

2506

</member>

2507

2508

<summary>Provide the component and perform any installation necessary to provide the component.</summary>

2509

</member>

2510

2511

2512

Specifies the run mode for <see cref="M:Microsoft.Deployment.WindowsInstaller.Session.GetMode(Microsoft.Deployment.WindowsInstaller.InstallRunMode)"/>.

2513

</summary>

2514

</member>

2515

2516

<summary>The administrative mode is installing, or the product is installing.</summary>

2517

</member>

2518

2519

<summary>The advertisements are installing or the product is installing or updating.</summary>

2520

</member>

2521

2522

<summary>An existing installation is being modified or there is a new installation.</summary>

2523

</member>

2524

2525

<summary>Rollback is enabled.</summary>

2526

</member>

2527

2528

<summary>The log file is active. It was enabled prior to the installation session.</summary>

2529

</member>

2530

2531

<summary>Execute operations are spooling or they are in the determination phase.</summary>

2532

</member>

2533

2534

<summary>A reboot is necessary after a successful installation (settable).</summary>

2535

</member>

2536

2537

<summary>A reboot is necessary to continue the installation (settable).</summary>

2538

</member>

2539

2540

<summary>Files from cabinets and Media table files are installing.</summary>

2541

</member>

2542

2543

<summary>The source LongFileNames is suppressed through the PID_MSISOURCE summary property.</summary>

2544

</member>

2545

2546

<summary>The target LongFileNames is suppressed through the SHORTFILENAMES property.</summary>

2547

</member>

2548

2549

<summary>The operating system is Windows 95, Windows 98, or Windows ME.</summary>

2550

</member>

2551

2552

<summary>The operating system supports demand installation.</summary>

2553

</member>

2554

2555

<summary>A custom action called from install script execution.</summary>

2556

</member>

2557

2558

<summary>A custom action called from rollback execution script.</summary>

2559

</member>

2560

2561

<summary>A custom action called from commit execution script.</summary>

2562

</member>

2563

2564

2565

Installed state of a Component or Feature.

2566

</summary>

2567

</member>

2568

2569

<summary>The component is disabled.</summary>

2570

</member>

2571

2572

<summary>The installation configuration data is corrupt.</summary>

2573

</member>

2574

2575

<summary>The installation is suspended or in progress.</summary>

2576

</member>

2577

2578

<summary>Component is set to run from source, but source is unavailable.</summary>

2579

</member>

2580

2581

<summary>The buffer overflow is returned.</summary>

2582

</member>

2583

2584

<summary>An invalid parameter was passed to the function.</summary>

2585

</member>

2586

2587

<summary>An unrecognized product or feature name was passed to the function.</summary>

2588

</member>

2589

2590

<summary>The component is broken.</summary>

2591

</member>

2592

2593

<summary>The feature is advertised.</summary>

2594

</member>

2595

2596

<summary>The component is being removed. In action state and not settable.</summary>

2597

</member>

2598

2599

<summary>The component is not installed, or action state is absent but clients remain.</summary>

2600

</member>

2601

2602

<summary>The component is installed on the local drive.</summary>

2603

</member>

2604

2605

<summary>The component will run from the source, CD, or network.</summary>

2606

</member>

2607

2608

<summary>The component will be installed in the default location: local or source.</summary>

2609

</member>

2610

2611

2612

Specifies the type of installation for <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.ApplyPatch(System.String,System.String,Microsoft.Deployment.WindowsInstaller.InstallType,System.String)"/>.

2613

</summary>

2614

</member>

2615

2616

<summary>Searches system for products to patch.</summary>

2617

</member>

2618

2619

<summary>Indicates a administrative installation.</summary>

2620

</member>

2621

2622

<summary>Indicates a particular instance.</summary>

2623

</member>

2624

2625

2626

Level of the installation user interface, specified with

2627

<see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetInternalUI(Microsoft.Deployment.WindowsInstaller.InstallUIOptions)"/>.

2628

</summary>

2629

</member>

2630

2631

<summary>Does not change UI level.</summary>

2632

</member>

2633

2634

<summary>Uses Default UI level.</summary>

2635

</member>

2636

2637

<summary>Silent installation.</summary>

2638

</member>

2639

2640

<summary>Simple progress and error handling.</summary>

2641

</member>

2642

2643

<summary>Authored UI, wizard dialogs suppressed.</summary>

2644

</member>

2645

2646

<summary>Authored UI with wizards, progress, and errors.</summary>

2647

</member>

2648

2649

2650

When combined with the <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallUIOptions.Basic"/> value, the installer does not display

2651

the cancel button in the progress dialog.

2652

</summary>

2653

</member>

2654

2655

2656

When combined with the <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallUIOptions.Basic"/> value, the installer displays progress

2657

dialog boxes but does not display any modal dialog boxes or error dialog boxes.

2658

</summary>

2659

</member>

2660

2661

2662

When combined with another value, the installer displays a modal dialog

2663

box at the end of a successful installation or if there has been an error.

2664

No dialog box is displayed if the user cancels.

2665

</summary>

2666

</member>

2667

2668

2669

Forces display of the source resolution dialog even if the UI is otherwise silent.

2670

</summary>

2671

</member>

2672

2673

2674

Specifies a return status value for message handlers. These values are returned by

2675

<see cref="M:Microsoft.Deployment.WindowsInstaller.Session.Message(Microsoft.Deployment.WindowsInstaller.InstallMessage,Microsoft.Deployment.WindowsInstaller.Record)"/>, <see cref="T:Microsoft.Deployment.WindowsInstaller.ExternalUIHandler"/>, and <see cref="M:Microsoft.Deployment.WindowsInstaller.IEmbeddedUI.ProcessMessage(Microsoft.Deployment.WindowsInstaller.InstallMessage,Microsoft.Deployment.WindowsInstaller.Record,Microsoft.Deployment.WindowsInstaller.MessageButtons,Microsoft.Deployment.WindowsInstaller.MessageIcon,Microsoft.Deployment.WindowsInstaller.MessageDefaultButton)"/>.

2676

</summary>

2677

</member>

2678

2679

<summary>An error was found in the message handler.</summary>

2680

</member>

2681

2682

<summary>No action was taken.</summary>

2683

</member>

2684

2685

2686

</member>

2687

2688

<summary>IDCANCEL</summary>

2689

</member>

2690

2691

<summary>IDABORT</summary>

2692

</member>

2693

2694

<summary>IDRETRY</summary>

2695

</member>

2696

2697

<summary>IDIGNORE</summary>

2698

</member>

2699

2700

<summary>IDYES</summary>

2701

</member>

2702

2703

2704

</member>

2705

2706

2707

Specifies constants defining which buttons to display for a message. This can be cast to

2708

the MessageBoxButtons enum in System.Windows.Forms and System.Windows.

2709

</summary>

2710

</member>

2711

2712

2713

The message contains an OK button.

2714

</summary>

2715

</member>

2716

2717

2718

The message contains OK and Cancel buttons.

2719

</summary>

2720

</member>

2721

2722

2723

The message contains Abort, Retry, and Ignore buttons.

2724

</summary>

2725

</member>

2726

2727

2728

The message contains Yes, No, and Cancel buttons.

2729

</summary>

2730

</member>

2731

2732

2733

The message contains Yes and No buttons.

2734

</summary>

2735

</member>

2736

2737

2738

The message contains Retry and Cancel buttons.

2739

</summary>

2740

</member>

2741

2742

2743

Specifies constants defining which information to display. This can be cast to

2744

the MessageBoxIcon enum in System.Windows.Forms and System.Windows.

2745

</summary>

2746

</member>

2747

2748

2749

The message contain no symbols.

2750

</summary>

2751

</member>

2752

2753

2754

The message contains a symbol consisting of white X in a circle with a red background.

2755

</summary>

2756

</member>

2757

2758

2759

The message contains a symbol consisting of a white X in a circle with a red background.

2760

</summary>

2761

</member>

2762

2763

2764

The message contains a symbol consisting of white X in a circle with a red background.

2765

</summary>

2766

</member>

2767

2768

2769

The message contains a symbol consisting of a question mark in a circle.

2770

</summary>

2771

</member>

2772

2773

2774

The message contains a symbol consisting of an exclamation point in a triangle with a yellow background.

2775

</summary>

2776

</member>

2777

2778

2779

The message contains a symbol consisting of an exclamation point in a triangle with a yellow background.

2780

</summary>

2781

</member>

2782

2783

2784

The message contains a symbol consisting of a lowercase letter i in a circle.

2785

</summary>

2786

</member>

2787

2788

2789

The message contains a symbol consisting of a lowercase letter i in a circle.

2790

</summary>

2791

</member>

2792

2793

2794

Specifies constants defining the default button on a message. This can be cast to

2795

the MessageBoxDefaultButton enum in System.Windows.Forms and System.Windows.

2796

</summary>

2797

</member>

2798

2799

2800

The first button on the message is the default button.

2801

</summary>

2802

</member>

2803

2804

2805

The second button on the message is the default button.

2806

</summary>

2807

</member>

2808

2809

2810

The third button on the message is the default button.

2811

</summary>

2812

</member>

2813

2814

2815

Specifies the different patch states for <see cref="M:Microsoft.Deployment.WindowsInstaller.PatchInstallation.GetPatches(System.String,System.String,System.String,Microsoft.Deployment.WindowsInstaller.UserContexts,Microsoft.Deployment.WindowsInstaller.PatchStates)"/>.

2816

</summary>

2817

</member>

2818

2819

<summary>Invalid value.</summary>

2820

</member>

2821

2822

<summary>Patches applied to a product.</summary>

2823

</member>

2824

2825

<summary>Patches that are superseded by other patches.</summary>

2826

</member>

2827

2828

<summary>Patches that are obsolesced by other patches.</summary>

2829

</member>

2830

2831

<summary>Patches that are registered to a product but not applied.</summary>

2832

</member>

2833

2834

<summary>All valid patch states.</summary>

2835

</member>

2836

2837

2838

Specifies the reinstall mode for <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.ReinstallFeature(System.String,System.String,Microsoft.Deployment.WindowsInstaller.ReinstallModes)"/> or <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.ReinstallProduct(System.String,Microsoft.Deployment.WindowsInstaller.ReinstallModes)"/>.

2839

</summary>

2840

</member>

2841

2842

<summary>Reinstall only if file is missing.</summary>

2843

</member>

2844

2845

<summary>Reinstall if file is missing, or older version.</summary>

2846

</member>

2847

2848

<summary>Reinstall if file is missing, or equal or older version.</summary>

2849

</member>

2850

2851

<summary>Reinstall if file is missing, or not exact version.</summary>

2852

</member>

2853

2854

<summary>Checksum executables, reinstall if missing or corrupt.</summary>

2855

</member>

2856

2857

<summary>Reinstall all files, regardless of version.</summary>

2858

</member>

2859

2860

<summary>Insure required machine reg entries.</summary>

2861

</member>

2862

2863

<summary>Insure required user reg entries.</summary>

2864

</member>

2865

2866

<summary>Validate shortcuts items.</summary>

2867

</member>

2868

2869

<summary>Use re-cache source install package.</summary>

2870

</member>

2871

2872

2873

Attributes for <see cref="T:Microsoft.Deployment.WindowsInstaller.Transaction"/> methods.

2874

</summary>

2875

</member>

2876

2877

<summary>No attributes.</summary>

2878

</member>

2879

2880

<summary>Request that the Windows Installer not shutdown the embedded UI until the transaction is complete.</summary>

2881

</member>

2882

2883

<summary>Request that the Windows Installer transfer the embedded UI from the original installation.</summary>

2884

</member>

2885

2886

2887

Transform error conditions available for <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.CreateTransformSummaryInfo(Microsoft.Deployment.WindowsInstaller.Database,System.String,Microsoft.Deployment.WindowsInstaller.TransformErrors,Microsoft.Deployment.WindowsInstaller.TransformValidations)"/> or

2888

<see cref="M:Microsoft.Deployment.WindowsInstaller.Database.ApplyTransform(System.String,Microsoft.Deployment.WindowsInstaller.TransformErrors)"/>.

2889

</summary>

2890

</member>

2891

2892

<summary>No error conditions.</summary>

2893

</member>

2894

2895

<summary>Adding a row that already exists.</summary>

2896

</member>

2897

2898

<summary>Deleting a row that doesn't exist.</summary>

2899

</member>

2900

2901

<summary>Adding a table that already exists.</summary>

2902

</member>

2903

2904

<summary>Deleting a table that doesn't exist.</summary>

2905

</member>

2906

2907

<summary>Updating a row that doesn't exist.</summary>

2908

</member>

2909

2910

<summary>Transform and database code pages do not match and neither code page is neutral.</summary>

2911

</member>

2912

2913

<summary>Create the temporary _TransformView table when applying the transform.</summary>

2914

</member>

2915

2916

2917

Transform validation flags available for <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.CreateTransformSummaryInfo(Microsoft.Deployment.WindowsInstaller.Database,System.String,Microsoft.Deployment.WindowsInstaller.TransformErrors,Microsoft.Deployment.WindowsInstaller.TransformValidations)"/>.

2918

</summary>

2919

</member>

2920

2921

<summary>Validate no properties.</summary>

2922

</member>

2923

2924

<summary>Default language must match base database.</summary>

2925

</member>

2926

2927

<summary>Product must match base database.</summary>

2928

</member>

2929

2930

<summary>Check major version only.</summary>

2931

</member>

2932

2933

<summary>Check major and minor versions only.</summary>

2934

</member>

2935

2936

<summary>Check major, minor, and update versions.</summary>

2937

</member>

2938

2939

<summary>Installed version < base version.</summary>

2940

</member>

2941

2942

<summary>Installed version <= base version.</summary>

2943

</member>

2944

2945

<summary>Installed version = base version.</summary>

2946

</member>

2947

2948

<summary>Installed version >= base version.</summary>

2949

</member>

2950

2951

<summary>Installed version > base version.</summary>

2952

</member>

2953

2954

<summary>UpgradeCode must match base database.</summary>

2955

</member>

2956

2957

2958

Specifies the installation context for <see cref="T:Microsoft.Deployment.WindowsInstaller.ProductInstallation"/>s,

2959

<see cref="T:Microsoft.Deployment.WindowsInstaller.PatchInstallation"/>es, and

2960

2961

</summary>

2962

</member>

2963

2964

<summary>Not installed.</summary>

2965

</member>

2966

2967

<summary>User managed install context.</summary>

2968

</member>

2969

2970

<summary>User non-managed context.</summary>

2971

</member>

2972

2973

<summary>Per-machine context.</summary>

2974

</member>

2975

2976

<summary>All contexts, or all valid values.</summary>

2977

</member>

2978

2979

<summary>All user-managed contexts.</summary>

2980

</member>

2981

2982

2983

Defines the type of error encountered by the <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Validate(Microsoft.Deployment.WindowsInstaller.Record)"/>, <see cref="M:Microsoft.Deployment.WindowsInstaller.View.ValidateNew(Microsoft.Deployment.WindowsInstaller.Record)"/>,

2984

or <see cref="M:Microsoft.Deployment.WindowsInstaller.View.ValidateFields(Microsoft.Deployment.WindowsInstaller.Record)"/> methods of the <see cref="T:Microsoft.Deployment.WindowsInstaller.View"/> class.

2985

</summary>

2986

</member>

2987

2988

<summary>No error.</summary>

2989

</member>

2990

2991

<summary>The new record duplicates primary keys of the existing record in a table.</summary>

2992

</member>

2993

2994

<summary>There are no null values allowed, or the column is about to be deleted but is referenced by another row.</summary>

2995

</member>

2996

2997

<summary>The corresponding record in a foreign table was not found.</summary>

2998

</member>

2999

3000

<summary>The data is greater than the maximum value allowed.</summary>

3001

</member>

3002

3003

<summary>The data is less than the minimum value allowed.</summary>

3004

</member>

3005

3006

<summary>The data is not a member of the values permitted in the set.</summary>

3007

</member>

3008

3009

<summary>An invalid version string was supplied.</summary>

3010

</member>

3011

3012

<summary>The case was invalid. The case must be all uppercase or all lowercase.</summary>

3013

</member>

3014

3015

<summary>An invalid GUID was supplied.</summary>

3016

</member>

3017

3018

<summary>An invalid wildcard file name was supplied, or the use of wildcards was invalid.</summary>

3019

</member>

3020

3021

<summary>An invalid identifier was supplied.</summary>

3022

</member>

3023

3024

<summary>Invalid language IDs were supplied.</summary>

3025

</member>

3026

3027

<summary>An invalid file name was supplied.</summary>

3028

</member>

3029

3030

<summary>An invalid path was supplied.</summary>

3031

</member>

3032

3033

<summary>An invalid conditional statement was supplied.</summary>

3034

</member>

3035

3036

<summary>An invalid format string was supplied.</summary>

3037

</member>

3038

3039

<summary>An invalid template string was supplied.</summary>

3040

</member>

3041

3042

<summary>An invalid string was supplied in the DefaultDir column of the Directory table.</summary>

3043

</member>

3044

3045

<summary>An invalid registry path string was supplied.</summary>

3046

</member>

3047

3048

<summary>An invalid string was supplied in the CustomSource column of the CustomAction table.</summary>

3049

</member>

3050

3051

<summary>An invalid property string was supplied.</summary>

3052

</member>

3053

3054

<summary>The _Validation table is missing a reference to a column.</summary>

3055

</member>

3056

3057

<summary>The category column of the _Validation table for the column is invalid.</summary>

3058

</member>

3059

3060

<summary>The table in the Keytable column of the _Validation table was not found or loaded.</summary>

3061

</member>

3062

3063

<summary>The value in the MaxValue column of the _Validation table is less than the value in the MinValue column.</summary>

3064

</member>

3065

3066

<summary>An invalid cabinet name was supplied.</summary>

3067

</member>

3068

3069

<summary>An invalid shortcut target name was supplied.</summary>

3070

</member>

3071

3072

<summary>The string is too long for the length specified by the column definition.</summary>

3073

</member>

3074

3075

<summary>An invalid localization attribute was supplied. (Primary keys cannot be localized.)</summary>

3076

</member>

3077

3078

3079

Specifies the modify mode for <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/>.

3080

</summary>

3081

</member>

3082

3083

3084

Refreshes the information in the supplied record without changing the position

3085

in the result set and without affecting subsequent fetch operations.

3086

</summary>

3087

</member>

3088

3089

<summary>Refreshes the data in a Record.</summary>

3090

</member>

3091

3092

<summary>Inserts a Record into the view.</summary>

3093

</member>

3094

3095

<summary>Updates the View with new data from the Record.</summary>

3096

</member>

3097

3098

<summary>Updates or inserts a Record into the View.</summary>

3099

</member>

3100

3101

<summary>Updates or deletes and inserts a Record into the View.</summary>

3102

</member>

3103

3104

<summary>Inserts or validates a record.</summary>

3105

</member>

3106

3107

<summary>Deletes a Record from the View.</summary>

3108

</member>

3109

3110

<summary>Inserts a Record into the View. The inserted data is not persistent.</summary>

3111

</member>

3112

3113

<summary>Validates a record.</summary>

3114

</member>

3115

3116

<summary>Validates a new record.</summary>

3117

</member>

3118

3119

<summary>Validates fields of a fetched or new record. Can validate one or more fields of an incomplete record.</summary>

3120

</member>

3121

3122

<summary>Validates a record that will be deleted later.</summary>

3123

</member>

3124

3125

3126

Base class for Windows Installer exceptions.

3127

</summary>

3128

</member>

3129

3130

3131

Creates a new InstallerException with a specified error message and a reference to the

3132

inner exception that is the cause of this exception.

3133

</summary>

3134

<param name="msg">The message that describes the error.</param>

3135

<param name="innerException">The exception that is the cause of the current exception. If the

3136

innerException parameter is not a null reference (Nothing in Visual Basic), the current exception

3137

is raised in a catch block that handles the inner exception.</param>

3138

</member>

3139

3140

3141

Creates a new InstallerException with a specified error message.

3142

</summary>

3143

<param name="msg">The message that describes the error.</param>

3144

</member>

3145

3146

3147

Creates a new InstallerException.

3148

</summary>

3149

</member>

3150

3151

3152

Initializes a new instance of the InstallerException class with serialized data.

3153

</summary>

3154

<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>

3155

<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>

3156

</member>

3157

3158

3159

Sets the SerializationInfo with information about the exception.

3160

</summary>

3161

<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>

3162

<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>

3163

</member>

3164

3165

3166

Gets extended information about the error, or null if no further information

3167

is available.

3168

</summary>

3169

<returns>A Record object. Field 1 of the Record contains the installer

3170

message code. Other fields contain data specific to the particular error.</returns>

3171

3172

If the record is passed to <see cref="M:Microsoft.Deployment.WindowsInstaller.Session.Message(Microsoft.Deployment.WindowsInstaller.InstallMessage,Microsoft.Deployment.WindowsInstaller.Record)"/>, it is formatted

3173

by looking up the string in the current database. If there is no installation

3174

session, the formatted error message may be obtained by a query on the Error table using

3175

the error code, followed by a call to <see cref="M:Microsoft.Deployment.WindowsInstaller.Record.ToString"/>.

3176

Alternatively, the standard MSI message can by retrieved by calling the

3177

<see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.GetErrorMessage(Microsoft.Deployment.WindowsInstaller.Record,System.Globalization.CultureInfo)"/> method.

3178

3179

The following methods and properties may report extended error data:

3180

3181

<item><see cref="T:Microsoft.Deployment.WindowsInstaller.Database"/> (constructor)</item>

3182

3183

3184

3185

3186

3187

3188

3189

3190

3191

3192

3193

3194

3195

3196

3197

3198

3199

3200

3201

3202

3203

3204

3205

3206

3207

3208

3209

3210

3211

3212

<item><see cref="T:Microsoft.Deployment.WindowsInstaller.SummaryInfo"/> (constructor)</item>

3213

3214

3215

3216

3217

3218

3219

3220

3221

3222

</list>

3223

3224

The Record object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

3225

It is best that the handle be closed manually as soon as it is no longer

3226

needed, as leaving lots of unused handles open can degrade performance.

3227

3228

Win32 MSI API:

3229

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetlasterrorrecord.asp">MsiGetLastErrorRecord</a>

3230

</remarks>

3231

</member>

3232

3233

3234

Gets the system error code that resulted in this exception, or 0 if not applicable.

3235

</summary>

3236

</member>

3237

3238

3239

Gets a message that describes the exception. This message may contain detailed

3240

formatted error data if it was available.

3241

</summary>

3242

</member>

3243

3244

3245

User Canceled the installation.

3246

</summary>

3247

</member>

3248

3249

3250

Creates a new InstallCanceledException with a specified error message and a reference to the

3251

inner exception that is the cause of this exception.

3252

</summary>

3253

<param name="msg">The message that describes the error.</param>

3254

<param name="innerException">The exception that is the cause of the current exception. If the

3255

innerException parameter is not a null reference (Nothing in Visual Basic), the current exception

3256

is raised in a catch block that handles the inner exception.</param>

3257

</member>

3258

3259

3260

Creates a new InstallCanceledException with a specified error message.

3261

</summary>

3262

<param name="msg">The message that describes the error.</param>

3263

</member>

3264

3265

3266

Creates a new InstallCanceledException.

3267

</summary>

3268

</member>

3269

3270

3271

Initializes a new instance of the InstallCanceledException class with serialized data.

3272

</summary>

3273

<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>

3274

<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>

3275

</member>

3276

3277

3278

A bad SQL query string was passed to <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.OpenView(System.String,System.Object[])"/> or <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.Execute(System.String,System.Object[])"/>.

3279

</summary>

3280

</member>

3281

3282

3283

Creates a new BadQuerySyntaxException with a specified error message and a reference to the

3284

inner exception that is the cause of this exception.

3285

</summary>

3286

<param name="msg">The message that describes the error.</param>

3287

<param name="innerException">The exception that is the cause of the current exception. If the

3288

innerException parameter is not a null reference (Nothing in Visual Basic), the current exception

3289

is raised in a catch block that handles the inner exception.</param>

3290

</member>

3291

3292

3293

Creates a new BadQuerySyntaxException with a specified error message.

3294

</summary>

3295

<param name="msg">The message that describes the error.</param>

3296

</member>

3297

3298

3299

Creates a new BadQuerySyntaxException.

3300

</summary>

3301

</member>

3302

3303

3304

Initializes a new instance of the BadQuerySyntaxException class with serialized data.

3305

</summary>

3306

<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>

3307

<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>

3308

</member>

3309

3310

3311

A method was called on an invalid installer handle. The handle may have been already closed.

3312

</summary>

3313

</member>

3314

3315

3316

Creates a new InvalidHandleException with a specified error message and a reference to the

3317

inner exception that is the cause of this exception.

3318

</summary>

3319

<param name="msg">The message that describes the error.</param>

3320

<param name="innerException">The exception that is the cause of the current exception. If the

3321

innerException parameter is not a null reference (Nothing in Visual Basic), the current exception

3322

is raised in a catch block that handles the inner exception.</param>

3323

</member>

3324

3325

3326

Creates a new InvalidHandleException with a specified error message.

3327

</summary>

3328

<param name="msg">The message that describes the error.</param>

3329

</member>

3330

3331

3332

Creates a new InvalidHandleException.

3333

</summary>

3334

</member>

3335

3336

3337

Initializes a new instance of the InvalidHandleException class with serialized data.

3338

</summary>

3339

<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>

3340

<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>

3341

</member>

3342

3343

3344

A failure occurred when executing <see cref="M:Microsoft.Deployment.WindowsInstaller.Database.Merge(Microsoft.Deployment.WindowsInstaller.Database,System.String)"/>. The exception may contain

3345

details about the merge conflict.

3346

</summary>

3347

</member>

3348

3349

3350

Creates a new MergeException with a specified error message and a reference to the

3351

inner exception that is the cause of this exception.

3352

</summary>

3353

<param name="msg">The message that describes the error.</param>

3354

<param name="innerException">The exception that is the cause of the current exception. If the

3355

innerException parameter is not a null reference (Nothing in Visual Basic), the current exception

3356

is raised in a catch block that handles the inner exception.</param>

3357

</member>

3358

3359

3360

Creates a new MergeException with a specified error message.

3361

</summary>

3362

<param name="msg">The message that describes the error.</param>

3363

</member>

3364

3365

3366

Creates a new MergeException.

3367

</summary>

3368

</member>

3369

3370

3371

Initializes a new instance of the MergeException class with serialized data.

3372

</summary>

3373

<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>

3374

<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>

3375

</member>

3376

3377

3378

Sets the SerializationInfo with information about the exception.

3379

</summary>

3380

<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>

3381

<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>

3382

</member>

3383

3384

3385

Gets the number of merge conflicts in each table, corresponding to the tables returned by

3386

<see cref="P:Microsoft.Deployment.WindowsInstaller.MergeException.ConflictTables"/>.

3387

</summary>

3388

</member>

3389

3390

3391

Gets the list of tables containing merge conflicts.

3392

</summary>

3393

</member>

3394

3395

3396

Gets a message that describes the merge conflits.

3397

</summary>

3398

</member>

3399

3400

3401

Defines a callback function that the installer calls for progress notification and error messages.

3402

</summary>

3403

</member>

3404

3405

3406

[MSI 3.1] Defines a callback function that the installer calls for record-based progress notification and error messages.

3407

</summary>

3408

</member>

3409

3410

3411

Provides static methods for installing and configuring products and patches.

3412

</summary>

3413

</member>

3414

3415

3416

Enables an external user-interface handler. This external UI handler is called before the

3417

normal internal user-interface handler. The external UI handler has the option to suppress

3418

the internal UI by returning a non-zero value to indicate that it has handled the messages.

3419

</summary>

3420

<param name="uiHandler">A callback delegate that handles the UI messages</param>

3421

<param name="messageFilter">Specifies which messages to handle using the external message handler.

3422

If the external handler returns a non-zero result, then that message will not be sent to the UI,

3423

instead the message will be logged if logging has been enabled.</param>

3424

<returns>The previously set external handler, or null if there was no previously set handler</returns>

3425

3426

To restore the previous UI handler, a second call is made to SetExternalUI using the

3427

ExternalUIHandler returned by the first call to SetExternalUI and specifying

3428

<see cref="F:Microsoft.Deployment.WindowsInstaller.InstallLogModes.None"/> as the message filter.

3429

3430

The external user interface handler does not have full control over the external user

3431

interface unless <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetInternalUI(Microsoft.Deployment.WindowsInstaller.InstallUIOptions)"/> is called with the uiLevel parameter set to

3432

<see cref="F:Microsoft.Deployment.WindowsInstaller.InstallUIOptions.Silent"/>. If SetInternalUI is not called, the internal user

3433

interface level defaults to <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallUIOptions.Basic"/>. As a result, any message not

3434

handled by the external user interface handler is handled by Windows Installer. The initial

3435

"Preparing to install..." dialog always appears even if the external user interface

3436

handler handles all messages.

3437

3438

SetExternalUI should only be called from a bootstrapping application. You cannot call

3439

it from a custom action

3440

3441

Win32 MSI API:

3442

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetexternalui.asp">MsiSetExternalUI</a>

3443

</remarks>

3444

</member>

3445

3446

3447

[MSI 3.1] Enables a record-based external user-interface handler. This external UI handler is called

3448

before the normal internal user-interface handler. The external UI handler has the option to suppress

3449

the internal UI by returning a non-zero value to indicate that it has handled the messages.

3450

</summary>

3451

<param name="uiHandler">A callback delegate that handles the UI messages</param>

3452

<param name="messageFilter">Specifies which messages to handle using the external message handler.

3453

If the external handler returns a non-zero result, then that message will not be sent to the UI,

3454

instead the message will be logged if logging has been enabled.</param>

3455

<returns>The previously set external handler, or null if there was no previously set handler</returns>

3456

3457

To restore the previous UI handler, a second call is made to SetExternalUI using the

3458

ExternalUIHandler returned by the first call to SetExternalUI and specifying

3459

<see cref="F:Microsoft.Deployment.WindowsInstaller.InstallLogModes.None"/> as the message filter.

3460

3461

The external user interface handler does not have full control over the external user

3462

interface unless <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetInternalUI(Microsoft.Deployment.WindowsInstaller.InstallUIOptions)"/> is called with the uiLevel parameter set to

3463

<see cref="F:Microsoft.Deployment.WindowsInstaller.InstallUIOptions.Silent"/>. If SetInternalUI is not called, the internal user

3464

interface level defaults to <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallUIOptions.Basic"/>. As a result, any message not

3465

handled by the external user interface handler is handled by Windows Installer. The initial

3466

"Preparing to install..." dialog always appears even if the external user interface

3467

handler handles all messages.

3468

3469

SetExternalUI should only be called from a bootstrapping application. You cannot call

3470

it from a custom action

3471

3472

Win32 MSI API:

3473

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetexternaluirecord.asp">MsiSetExternalUIRecord</a>

3474

</remarks>

3475

</member>

3476

3477

3478

Enables the installer's internal user interface. Then this user interface is used

3479

for all subsequent calls to user-interface-generating installer functions in this process.

3480

</summary>

3481

<param name="uiOptions">Specifies the level of complexity of the user interface</param>

3482

<param name="windowHandle">Handle to a window, which becomes the owner of any user interface created.

3483

A pointer to the previous owner of the user interface is returned.</param>

3484

<returns>The previous user interface level</returns>

3485

3486

Win32 MSI API:

3487

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetinternalui.asp">MsiSetInternalUI</a>

3488

</remarks>

3489

</member>

3490

3491

3492

Enables the installer's internal user interface. Then this user interface is used

3493

for all subsequent calls to user-interface-generating installer functions in this process.

3494

The owner of the user interface does not change.

3495

</summary>

3496

<param name="uiOptions">Specifies the level of complexity of the user interface</param>

3497

<returns>The previous user interface level</returns>

3498

3499

Win32 MSI API:

3500

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetinternalui.asp">MsiSetInternalUI</a>

3501

</remarks>

3502

</member>

3503

3504

3505

Enables logging of the selected message type for all subsequent install sessions in

3506

the current process space.

3507

</summary>

3508

<param name="logModes">One or more mode flags specifying the type of messages to log</param>

3509

<param name="logFile">Full path to the log file. A null path disables logging,

3510

in which case the logModes paraneter is ignored.</param>

3511

<exception cref="T:System.ArgumentException">an invalid log mode was specified</exception>

3512

<remarks>This method takes effect on any new installation processes. Calling this

3513

method from within a custom action will not start logging for that installation.</remarks>

3514

</member>

3515

3516

3517

Enables logging of the selected message type for all subsequent install sessions in

3518

the current process space.

3519

</summary>

3520

<param name="logModes">One or more mode flags specifying the type of messages to log</param>

3521

<param name="logFile">Full path to the log file. A null path disables logging,

3522

in which case the logModes paraneter is ignored.</param>

3523

<param name="append">If true, the log lines will be appended to any existing file content.

3524

If false, the log file will be truncated if it exists. The default is false.</param>

3525

<param name="flushEveryLine">If true, the log will be flushed after every line.

3526

If false, the log will be flushed every 20 lines. The default is true.</param>

3527

<exception cref="T:System.ArgumentException">an invalid log mode was specified</exception>

3528

3529

This method takes effect on any new installation processes. Calling this

3530

method from within a custom action will not start logging for that installation.

3531

3532

Win32 MSI API:

3533

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienablelog.asp">MsiEnableLog</a>

3534

</remarks>

3535

</member>

3536

3537

3538

increments the usage count for a particular feature and returns the installation state for

3539

that feature. This method should be used to indicate an application's intent to use a feature.

3540

</summary>

3541

<param name="productCode">The product code of the product.</param>

3542

<param name="feature">The feature to be used.</param>

3543

<param name="installMode">Must have the value <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallMode.NoDetection"/>.</param>

3544

<returns>The installed state of the feature.</returns>

3545

3546

The UseFeature method should only be used on features known to be published. The application

3547

should determine the status of the feature by calling either the FeatureState method or

3548

Features method.

3549

3550

Win32 MSI APIs:

3551

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiusefeature.asp">MsiUseFeature</a>,

3552

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiusefeatureex.asp">MsiUseFeatureEx</a>

3553

</remarks>

3554

</member>

3555

3556

3557

Opens an installer package for use with functions that access the product database and install engine,

3558

returning an Session object.

3559

</summary>

3560

<param name="packagePath">Path to the package</param>

3561

<param name="ignoreMachineState">Specifies whether or not the create a Session object that ignores the

3562

computer state and that is incapable of changing the current computer state. A value of false yields

3563

the normal behavior. A value of true creates a "safe" Session object that cannot change of the current

3564

machine state.</param>

3565

<returns>A Session object allowing access to the product database and install engine</returns>

3566

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The product could not be opened</exception>

3567

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

3568

3569

Note that only one Session object can be opened by a single process. OpenPackage cannot be used in a

3570

custom action because the active installation is the only session allowed.

3571

3572

A "safe" Session object ignores the current computer state when opening the package and prevents

3573

changes to the current computer state.

3574

3575

The Session object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

3576

It is best that the handle be closed manually as soon as it is no longer

3577

needed, as leaving lots of unused handles open can degrade performance.

3578

3579

Win32 MSI APIs:

3580

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopenpackage.asp">MsiOpenPackage</a>,

3581

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopenpackageex.asp">MsiOpenPackageEx</a>

3582

</remarks>

3583

</member>

3584

3585

3586

Opens an installer package for use with functions that access the product database and install engine,

3587

returning an Session object.

3588

</summary>

3589

<param name="database">Database used to create the session</param>

3590

<param name="ignoreMachineState">Specifies whether or not the create a Session object that ignores the

3591

computer state and that is incapable of changing the current computer state. A value of false yields

3592

the normal behavior. A value of true creates a "safe" Session object that cannot change of the current

3593

machine state.</param>

3594

<returns>A Session object allowing access to the product database and install engine</returns>

3595

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The product could not be opened</exception>

3596

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

3597

3598

Note that only one Session object can be opened by a single process. OpenPackage cannot be used in a

3599

custom action because the active installation is the only session allowed.

3600

3601

A "safe" Session object ignores the current computer state when opening the package and prevents

3602

changes to the current computer state.

3603

3604

The Session object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

3605

It is best that the handle be closed manually as soon as it is no longer

3606

needed, as leaving lots of unused handles open can degrade performance.

3607

3608

Win32 MSI APIs:

3609

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopenpackage.asp">MsiOpenPackage</a>,

3610

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopenpackageex.asp">MsiOpenPackageEx</a>

3611

</remarks>

3612

</member>

3613

3614

3615

Opens an installer package for an installed product using the product code.

3616

</summary>

3617

<param name="productCode">Product code of the installed product</param>

3618

<returns>A Session object allowing access to the product database and install engine,

3619

or null if the specified product is not installed.</returns>

3620

<exception cref="T:System.ArgumentException">An unknown product was requested</exception>

3621

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The product could not be opened</exception>

3622

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

3623

3624

Note that only one Session object can be opened by a single process. OpenProduct cannot be

3625

used in a custom action because the active installation is the only session allowed.

3626

3627

The Session object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

3628

It is best that the handle be closed manually as soon as it is no longer

3629

needed, as leaving lots of unused handles open can degrade performance.

3630

3631

Win32 MSI API:

3632

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiopenproduct.asp">MsiOpenProduct</a>

3633

</remarks>

3634

</member>

3635

3636

3637

Gets the full component path, performing any necessary installation. This method prompts for source if

3638

necessary and increments the usage count for the feature.

3639

</summary>

3640

<param name="product">Product code for the product that contains the feature with the necessary component</param>

3641

<param name="feature">Feature ID of the feature with the necessary component</param>

3642

<param name="component">Component code of the necessary component</param>

3643

<param name="installMode">Installation mode; this can also include bits from <see cref="T:Microsoft.Deployment.WindowsInstaller.ReinstallModes"/></param>

3644

<returns>Path to the component</returns>

3645

3646

Win32 MSI API:

3647

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprovidecomponent.asp">MsiProvideComponent</a>

3648

</remarks>

3649

</member>

3650

3651

3652

Gets the full component path for a qualified component that is published by a product and

3653

performs any necessary installation. This method prompts for source if necessary and increments

3654

the usage count for the feature.

3655

</summary>

3656

<param name="component">Specifies the component ID for the requested component. This may not be the

3657

GUID for the component itself but rather a server that provides the correct functionality, as in the

3658

ComponentId column of the PublishComponent table.</param>

3659

<param name="qualifier">Specifies a qualifier into a list of advertising components (from PublishComponent Table).</param>

3660

<param name="installMode">Installation mode; this can also include bits from <see cref="T:Microsoft.Deployment.WindowsInstaller.ReinstallModes"/></param>

3661

<param name="product">Optional; specifies the product to match that has published the qualified component.</param>

3662

<returns>Path to the component</returns>

3663

3664

Win32 MSI APIs:

3665

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprovidequalifiedcomponent.asp">MsiProvideQualifiedComponent</a>

3666

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprovidequalifiedcomponentex.asp">MsiProvideQualifiedComponentEx</a>

3667

</remarks>

3668

</member>

3669

3670

3671

Gets the full path to a Windows Installer component containing an assembly. This method prompts for a source and

3672

increments the usage count for the feature.

3673

</summary>

3674

<param name="assemblyName">Assembly name</param>

3675

<param name="appContext">Set to null for global assemblies. For private assemblies, set to the full path of the

3676

application configuration file (.cfg file) or executable file (.exe) of the application to which the assembly

3677

has been made private.</param>

3678

<param name="installMode">Installation mode; this can also include bits from <see cref="T:Microsoft.Deployment.WindowsInstaller.ReinstallModes"/></param>

3679

<param name="isWin32Assembly">True if this is a Win32 assembly, false if it is a .NET assembly</param>

3680

<returns>Path to the assembly</returns>

3681

3682

Win32 MSI API:

3683

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprovideassembly.asp">MsiProvideAssembly</a>

3684

</remarks>

3685

</member>

3686

3687

3688

Installs files that are unexpectedly missing.

3689

</summary>

3690

<param name="product">Product code for the product that owns the component to be installed</param>

3691

<param name="component">Component to be installed</param>

3692

<param name="installState">Specifies the way the component should be installed.</param>

3693

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

3694

3695

Win32 MSI API:

3696

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiinstallmissingcomponent.asp">MsiInstallMissingComponent</a>

3697

</remarks>

3698

</member>

3699

3700

3701

Installs files that are unexpectedly missing.

3702

</summary>

3703

<param name="product">Product code for the product that owns the file to be installed</param>

3704

<param name="file">File to be installed</param>

3705

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

3706

3707

Win32 MSI API:

3708

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiinstallmissingfile.asp">MsiInstallMissingFile</a>

3709

</remarks>

3710

</member>

3711

3712

3713

Reinstalls a feature.

3714

</summary>

3715

<param name="product">Product code for the product containing the feature to be reinstalled</param>

3716

<param name="feature">Feature to be reinstalled</param>

3717

<param name="reinstallModes">Reinstall modes</param>

3718

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

3719

3720

Win32 MSI API:

3721

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msireinstallfeature.asp">MsiReinstallFeature</a>

3722

</remarks>

3723

</member>

3724

3725

3726

Reinstalls a product.

3727

</summary>

3728

<param name="product">Product code for the product to be reinstalled</param>

3729

<param name="reinstallModes">Reinstall modes</param>

3730

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

3731

3732

Win32 MSI API:

3733

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msireinstallproduct.asp">MsiReinstallProduct</a>

3734

</remarks>

3735

</member>

3736

3737

3738

Opens an installer package and initializes an install session.

3739

</summary>

3740

<param name="packagePath">path to the patch package</param>

3741

<param name="commandLine">command line property settings</param>

3742

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">There was an error installing the product</exception>

3743

3744

To completely remove a product, set REMOVE=ALL in <paramRef name="commandLine"/>.

3745

3746

This method displays the user interface with the current settings and

3747

log mode. You can change user interface settings with the <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetInternalUI(Microsoft.Deployment.WindowsInstaller.InstallUIOptions)"/>

3748

and <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetExternalUI(Microsoft.Deployment.WindowsInstaller.ExternalUIHandler,Microsoft.Deployment.WindowsInstaller.InstallLogModes)"/> functions. You can set the log mode with the

3749

<see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.EnableLog(Microsoft.Deployment.WindowsInstaller.InstallLogModes,System.String)"/> function.

3750

3751

The <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootRequired"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootInitiated"/> properties should be

3752

tested after calling this method.

3753

3754

Win32 MSI API:

3755

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiinstallproduct.asp">MsiInstallProduct</a>

3756

</remarks>

3757

</member>

3758

3759

3760

Installs or uninstalls a product.

3761

</summary>

3762

<param name="productCode">Product code of the product to be configured.</param>

3763

<param name="installLevel">Specifies the default installation configuration of the

3764

product. The <paramref name="installLevel"/> parameter is ignored and all features

3765

are installed if the <paramref name="installState"/> parameter is set to any other

3766

value than <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallState.Default"/>. This parameter must be either 0

3767

(install using authored feature levels), 65535 (install all features), or a value

3768

between 0 and 65535 to install a subset of available features. </param>

3769

<param name="installState">Specifies the installation state for the product.</param>

3770

<param name="commandLine">Specifies the command line property settings. This should

3771

be a list of the format Property=Setting Property=Setting.</param>

3772

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">There was an error configuring the product</exception>

3773

3774

This method displays the user interface with the current settings and

3775

log mode. You can change user interface settings with the <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetInternalUI(Microsoft.Deployment.WindowsInstaller.InstallUIOptions)"/>

3776

and <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetExternalUI(Microsoft.Deployment.WindowsInstaller.ExternalUIHandler,Microsoft.Deployment.WindowsInstaller.InstallLogModes)"/> functions. You can set the log mode with the

3777

<see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.EnableLog(Microsoft.Deployment.WindowsInstaller.InstallLogModes,System.String)"/> function.

3778

3779

The <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootRequired"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootInitiated"/> properties should be

3780

tested after calling this method.

3781

3782

Win32 MSI APIs:

3783

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiconfigureproduct.asp">MsiConfigureProduct</a>,

3784

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiconfigureproductex.asp">MsiConfigureProductEx</a>

3785

</remarks>

3786

</member>

3787

3788

3789

Configures the installed state for a product feature.

3790

</summary>

3791

<param name="productCode">Product code of the product to be configured.</param>

3792

<param name="feature">Specifies the feature ID for the feature to be configured.</param>

3793

<param name="installState">Specifies the installation state for the feature.</param>

3794

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">There was an error configuring the feature</exception>

3795

3796

The <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootRequired"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootInitiated"/> properties should be

3797

tested after calling this method.

3798

3799

Win32 MSI API:

3800

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiconfigurefeature.asp">MsiConfigureFeature</a>

3801

</remarks>

3802

</member>

3803

3804

3805

For each product listed by the patch package as eligible to receive the patch, ApplyPatch invokes

3806

an installation and sets the PATCH property to the path of the patch package.

3807

</summary>

3808

<param name="patchPackage">path to the patch package</param>

3809

<param name="commandLine">optional command line property settings</param>

3810

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">There was an error applying the patch</exception>

3811

3812

The <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootRequired"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootInitiated"/> properties should be

3813

tested after calling this method.

3814

3815

Win32 MSI API:

3816

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiapplypatch.asp">MsiApplyPatch</a>

3817

</remarks>

3818

</member>

3819

3820

3821

For each product listed by the patch package as eligible to receive the patch, ApplyPatch invokes

3822

an installation and sets the PATCH property to the path of the patch package.

3823

</summary>

3824

<param name="patchPackage">path to the patch package</param>

3825

<param name="installPackage">path to the product to be patched, if installType

3826

is set to <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallType.NetworkImage"/></param>

3827

<param name="installType">type of installation to patch</param>

3828

<param name="commandLine">optional command line property settings</param>

3829

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">There was an error applying the patch</exception>

3830

3831

The <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootRequired"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootInitiated"/> properties should be

3832

tested after calling this method.

3833

3834

Win32 MSI API:

3835

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiapplypatch.asp">MsiApplyPatch</a>

3836

</remarks>

3837

</member>

3838

3839

3840

Removes one or more patches from a single product. To remove a patch from

3841

multiple products, RemovePatches must be called for each product.

3842

</summary>

3843

<param name="patches">List of patches to remove. Each patch can be specified by the GUID

3844

of the patch or the full path to the patch package.</param>

3845

<param name="productCode">The ProductCode (GUID) of the product from which the patches

3846

are removed. This parameter cannot be null.</param>

3847

<param name="commandLine">optional command line property settings</param>

3848

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">There was an error removing the patches</exception>

3849

3850

The <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootRequired"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.Installer.RebootInitiated"/> properties should be

3851

tested after calling this method.

3852

3853

Win32 MSI API:

3854

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiremovepatches.asp">MsiRemovePatches</a>

3855

</remarks>

3856

</member>

3857

3858

3859

Determines which patches apply to a specified product MSI and in what sequence.

3860

</summary>

3861

<param name="productPackage">Full path to an MSI file that is the target product

3862

for the set of patches.</param>

3863

<param name="patches">An array of strings specifying the patches to be checked. Each item

3864

may be the path to an MSP file, the path an XML file, or just an XML blob.</param>

3865

<param name="errorHandler">Callback to be invoked for each inapplicable patch, reporting the

3866

reason the patch is not applicable. This value may be left null if that information is not

3867

desired.</param>

3868

<returns>An array of selected patch strings from <paramref name="patches"/>, indicating

3869

the set of applicable patches. The items are re-ordered to be in the best sequence.</returns>

3870

3871

If an item in <paramref name="patches"/> is a file path but does not end in .MSP or .XML,

3872

it is assumed to be an MSP file.

3873

3874

As this overload uses InstallContext.None, it does not consider the current state of

3875

the system.

3876

3877

Win32 MSI API:

3878

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidetermineapplicablepatches.asp">MsiDetermineApplicablePatches</a>

3879

</remarks>

3880

</member>

3881

3882

3883

Determines which patches apply to a specified product and in what sequence. If

3884

the product is installed, this method accounts for patches that have already been applied to

3885

the product and accounts for obsolete and superceded patches.

3886

</summary>

3887

<param name="product">The product that is the target for the set of patches. This may be

3888

either a ProductCode (GUID) of a product that is currently installed, or the path to a an

3889

MSI file.</param>

3890

<param name="patches">An array of strings specifying the patches to be checked. Each item

3891

may be the path to an MSP file, the path an XML file, or just an XML blob.</param>

3892

<param name="errorHandler">Callback to be invoked for each inapplicable patch, reporting the

3893

reason the patch is not applicable. This value may be left null if that information is not

3894

desired.</param>

3895

<param name="userSid">Specifies a security identifier (SID) of a user. This parameter restricts

3896

the context of enumeration for this user account. This parameter cannot be the special SID

3897

strings s-1-1-0 (everyone) or s-1-5-18 (local system). If <paramref name="context"/> is set to

3898

<see cref="F:Microsoft.Deployment.WindowsInstaller.UserContexts.None"/> or <see cref="F:Microsoft.Deployment.WindowsInstaller.UserContexts.Machine"/>, then

3899

<paramref name="userSid"/> must be null. For the current user context, <paramref name="userSid"/>

3900

can be null and <paramref name="context"/> can be set to <see cref="F:Microsoft.Deployment.WindowsInstaller.UserContexts.UserManaged"/>

3901

or <see cref="F:Microsoft.Deployment.WindowsInstaller.UserContexts.UserUnmanaged"/>.</param>

3902

<param name="context">Restricts the enumeration to per-user-unmanaged, per-user-managed,

3903

or per-machine context, or (if referring to an MSI) to no system context at all. This

3904

parameter can be <see cref="F:Microsoft.Deployment.WindowsInstaller.UserContexts.Machine"/>, <see cref="F:Microsoft.Deployment.WindowsInstaller.UserContexts.UserManaged"/>,

3905

3906

<returns>An array of selected patch strings from <paramref name="patches"/>, indicating

3907

the set of applicable patches. The items are re-ordered to be in the best sequence.</returns>

3908

3909

If an item in <paramref name="patches"/> is a file path but does not end in .MSP or .XML,

3910

it is assumed to be an MSP file.

3911

3912

Passing an InstallContext of None only analyzes the MSI file; it does not consider the

3913

current state of the system. You cannot use InstallContext.None with a ProductCode GUID.

3914

3915

Win32 MSI APIs:

3916

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidetermineapplicablepatches.asp">MsiDetermineApplicablePatches</a>

3917

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msideterminepatchsequence.asp">MsiDeterminePatchSequence</a>

3918

</remarks>

3919

</member>

3920

3921

3922

Applies one or more patches to products that are eligible to receive the patch.

3923

For each product listed by the patch package as eligible to receive the patch, ApplyPatch invokes

3924

an installation and sets the PATCH property to the path of the patch package.

3925

</summary>

3926

<param name="patchPackages">The set of patch packages to be applied.

3927

Each item is the full path to an MSP file.</param>

3928

<param name="productCode">Provides the ProductCode of the product being patched. If this parameter

3929

is null, the patches are applied to all products that are eligible to receive these patches.</param>

3930

<param name="commandLine">optional command line property settings</param>

3931

3932

Win32 MSI API:

3933

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiapplymultiplepatches.asp">MsiApplyMultiplePatches</a>

3934

</remarks>

3935

</member>

3936

3937

3938

Extracts information from a patch that can be used to determine whether the patch

3939

applies on a target system. The method returns an XML string that can be provided to

3940

3941

instead of the full patch file.

3942

</summary>

3943

<param name="patchPath">Full path to the patch being queried.</param>

3944

<returns>XML string containing patch data.</returns>

3945

3946

Win32 MSI API:

3947

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiextractpatchxmldata.asp">MsiExtractPatchXMLData</a>

3948

</remarks>

3949

</member>

3950

3951

3952

[MSI 3.1] Migrates a user's application configuration data to a new SID.

3953

</summary>

3954

<param name="oldSid">Previous user SID that data is to be migrated from</param>

3955

<param name="newSid">New user SID that data is to be migrated to</param>

3956

3957

Win32 MSI API:

3958

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msinotifysidchange.asp">MsiNotifySidChange</a>

3959

</remarks>

3960

</member>

3961

3962

3963

Advertises a product to the local computer.

3964

</summary>

3965

<param name="packagePath">Path to the package of the product being advertised</param>

3966

<param name="perUser">True if the product is user-assigned; false if it is machine-assigned.</param>

3967

<param name="transforms">Semi-colon delimited list of transforms to be applied. This parameter may be null.</param>

3968

<param name="locale">The language to use if the source supports multiple languages</param>

3969

<exception cref="T:System.IO.FileNotFoundException">the specified package file does not exist</exception>

3970

3971

3972

Win32 MSI APIs:

3973

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiadvertiseproduct.asp">MsiAdvertiseProduct</a>,

3974

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiadvertiseproductex.asp">MsiAdvertiseProductEx</a>

3975

</remarks>

3976

</member>

3977

3978

3979

Generates an advertise script. The method enables the installer to write to a

3980

script the registry and shortcut information used to assign or publish a product.

3981

</summary>

3982

<param name="packagePath">Path to the package of the product being advertised</param>

3983

<param name="scriptFilePath">path to script file to be created with the advertise information</param>

3984

<param name="transforms">Semi-colon delimited list of transforms to be applied. This parameter may be null.</param>

3985

<param name="locale">The language to use if the source supports multiple languages</param>

3986

<exception cref="T:System.IO.FileNotFoundException">the specified package file does not exist</exception>

3987

3988

3989

Win32 MSI APIs:

3990

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiadvertiseproduct.asp">MsiAdvertiseProduct</a>,

3991

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiadvertiseproductex.asp">MsiAdvertiseProductEx</a>

3992

</remarks>

3993

</member>

3994

3995

3996

Generates an advertise script. The method enables the installer to write to a

3997

script the registry and shortcut information used to assign or publish a product.

3998

</summary>

3999

<param name="packagePath">Path to the package of the product being advertised</param>

4000

<param name="scriptFilePath">path to script file to be created with the advertise information</param>

4001

<param name="transforms">Semi-colon delimited list of transforms to be applied. This parameter may be null.</param>

4002

<param name="locale">The language to use if the source supports multiple languages</param>

4003

<param name="processor">Targeted processor architecture.</param>

4004

<param name="instance">True to install multiple instances through product code changing transform.

4005

Advertises a new instance of the product. Requires that the <paramref name="transforms"/> parameter

4006

includes the instance transform that changes the product code.</param>

4007

4008

4009

Win32 MSI APIs:

4010

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiadvertiseproduct.asp">MsiAdvertiseProduct</a>,

4011

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiadvertiseproductex.asp">MsiAdvertiseProductEx</a>

4012

</remarks>

4013

</member>

4014

4015

4016

Copies an advertise script file to the local computer.

4017

</summary>

4018

<param name="scriptFile">Path to a script file generated by

4019

4020

<param name="flags">Flags controlling advertisement</param>

4021

<param name="removeItems">True if specified items are to be removed instead of being created</param>

4022

4023

The process calling this function must be running under the LocalSystem account. To advertise an

4024

application for per-user installation to a targeted user, the thread that calls this function must

4025

impersonate the targeted user. If the thread calling this function is not impersonating a targeted

4026

user, the application is advertised to all users for installation with elevated privileges.

4027

</remarks>

4028

</member>

4029

4030

4031

Processes an advertise script file into the specified locations.

4032

</summary>

4033

<param name="scriptFile">Path to a script file generated by

4034

4035

<param name="iconFolder">An optional path to a folder in which advertised icon files and transform

4036

files are located. If this parameter is null, no icon or transform files are written.</param>

4037

<param name="shortcuts">True if shortcuts should be created</param>

4038

<param name="removeItems">True if specified items are to be removed instead of created</param>

4039

4040

The process calling this function must be running under the LocalSystem account. To advertise an

4041

application for per-user installation to a targeted user, the thread that calls this function must

4042

impersonate the targeted user. If the thread calling this function is not impersonating a targeted

4043

user, the application is advertised to all users for installation with elevated privileges.

4044

4045

Win32 MSI API:

4046

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprocessadvertisescript.asp">MsiProcessAdvertiseScript</a>

4047

</remarks>

4048

</member>

4049

4050

4051

Gets product information for an installer script file.

4052

</summary>

4053

<param name="scriptFile">Path to a script file generated by

4054

4055

<returns>ProductInstallation stub with advertise-related properties filled in.</returns>

4056

<exception cref="T:System.ArgumentOutOfRangeException">An invalid product property was requested</exception>

4057

4058

Only the following properties will be filled in in the returned object:<ul>

4059

4060

4061

4062

4063

4064

</ul>Other properties will be null.

4065

4066

Win32 MSI API:

4067

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetproductinfofromscript.asp">MsiGetProductInfoFromScript</a>

4068

</remarks>

4069

</member>

4070

4071

4072

Gets a Windows Installer error message in the system default language.

4073

</summary>

4074

<param name="errorNumber">The error number.</param>

4075

<returns>The message string, or null if the error message is not found.</returns>

4076

4077

The returned string may have tokens such as [2] and [3] that are meant to be substituted

4078

with context-specific values.

4079

4080

Error numbers greater than 2000 refer to MSI "internal" errors, and are always

4081

returned in English.

4082

</remarks>

4083

</member>

4084

4085

4086

Gets a Windows Installer error message in a specified language.

4087

</summary>

4088

<param name="errorNumber">The error number.</param>

4089

<param name="culture">The locale for the message.</param>

4090

<returns>The message string, or null if the error message or locale is not found.</returns>

4091

4092

The returned string may have tokens such as [2] and [3] that are meant to be substituted

4093

with context-specific values.

4094

4095

Error numbers greater than 2000 refer to MSI "internal" errors, and are always

4096

returned in English.

4097

</remarks>

4098

</member>

4099

4100

4101

Gets a formatted Windows Installer error message in the system default language.

4102

</summary>

4103

<param name="errorRecord">Error record containing the error number in the first field, and

4104

error-specific parameters in the other fields.</param>

4105

<returns>The message string, or null if the error message is not found.</returns>

4106

4107

Error numbers greater than 2000 refer to MSI "internal" errors, and are always

4108

returned in English.

4109

</remarks>

4110

</member>

4111

4112

4113

Gets a formatted Windows Installer error message in a specified language.

4114

</summary>

4115

<param name="errorRecord">Error record containing the error number in the first field, and

4116

error-specific parameters in the other fields.</param>

4117

<param name="culture">The locale for the message.</param>

4118

<returns>The message string, or null if the error message or locale is not found.</returns>

4119

4120

Error numbers greater than 2000 refer to MSI "internal" errors, and are always

4121

returned in English.

4122

</remarks>

4123

</member>

4124

4125

4126

Gets the version string of the path specified using the format that the installer

4127

expects to find it in in the database.

4128

</summary>

4129

4130

<returns>Version string in the "#.#.#.#" format, or an empty string if the file

4131

does not contain version information</returns>

4132

<exception cref="T:System.IO.FileNotFoundException">the file does not exist or could not be read</exception>

4133

4134

Win32 MSI API:

4135

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfileversion.asp">MsiGetFileVersion</a>

4136

</remarks>

4137

</member>

4138

4139

4140

Gets the language string of the path specified using the format that the installer

4141

expects to find them in in the database.

4142

</summary>

4143

4144

<returns>Language string in the form of a decimal language ID, or an empty string if the file

4145

does not contain a language ID</returns>

4146

<exception cref="T:System.IO.FileNotFoundException">the file does not exist or could not be read</exception>

4147

4148

Win32 MSI API:

4149

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfileversion.asp">MsiGetFileVersion</a>

4150

</remarks>

4151

</member>

4152

4153

4154

Gets a 128-bit hash of the specified file.

4155

</summary>

4156

4157

<param name="hash">Integer array of length 4 which receives the

4158

four 32-bit parts of the hash value.</param>

4159

<exception cref="T:System.IO.FileNotFoundException">the file does not exist or

4160

could not be read</exception>

4161

4162

Win32 MSI API:

4163

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfilehash.asp">MsiGetFileHash</a>

4164

</remarks>

4165

</member>

4166

4167

4168

Examines a shortcut and returns its product, feature name, and component if available.

4169

</summary>

4170

<param name="shortcut">Full path to a shortcut</param>

4171

<returns>ShortcutTarget structure containing target product code, feature, and component code</returns>

4172

4173

Win32 MSI API:

4174

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetshortcuttarget.asp">MsiGetShortcutTarget</a>

4175

</remarks>

4176

</member>

4177

4178

4179

Verifies that the given file is an installation package.

4180

</summary>

4181

<param name="packagePath">Path to the package</param>

4182

<returns>True if the file is an installation package; false otherwise.</returns>

4183

<exception cref="T:System.IO.FileNotFoundException">the specified package file does not exist</exception>

4184

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the package file could not be opened</exception>

4185

4186

Win32 MSI API:

4187

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiverifypackage.asp">MsiVerifyPackage</a>

4188

</remarks>

4189

</member>

4190

4191

4192

[MSI 4.0] Gets the list of files that can be updated by one or more patches.

4193

</summary>

4194

<param name="productCode">ProductCode (GUID) of the product which is

4195

the target of the patches</param>

4196

<param name="patches">list of file paths of one or more patches to be

4197

analyzed</param>

4198

<returns>List of absolute paths of files that can be updated when the

4199

patches are applied on this system.</returns>

4200

4201

Win32 MSI API:

4202

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetpatchfilelist.asp">MsiGetPatchFileList</a>

4203

</remarks>

4204

</member>

4205

4206

4207

Indicates whether a system reboot is required after running an installation or configuration operation.

4208

</summary>

4209

</member>

4210

4211

4212

Indicates whether a system reboot has been initiated after running an installation or configuration operation.

4213

</summary>

4214

</member>

4215

4216

4217

Gets the current version of the installer.

4218

</summary>

4219

</member>

4220

4221

4222

Accessor for information about features within the context of an installation session.

4223

</summary>

4224

</member>

4225

4226

4227

Checks if the collection contains a feature.

4228

</summary>

4229

<param name="feature">name of the feature</param>

4230

<returns>true if the feature is in the collection, else false</returns>

4231

</member>

4232

4233

4234

Copies the features into an array.

4235

</summary>

4236

<param name="array">array that receives the features</param>

4237

<param name="arrayIndex">offset into the array</param>

4238

</member>

4239

4240

4241

Enumerates the features in the collection.

4242

</summary>

4243

<returns>an enumerator over all features in the collection</returns>

4244

</member>

4245

4246

4247

Gets information about a feature within the context of an installation session.

4248

</summary>

4249

<param name="feature">name of the feature</param>

4250

<returns>feature object</returns>

4251

</member>

4252

4253

4254

Gets the number of features defined for the product.

4255

</summary>

4256

</member>

4257

4258

4259

Provides access to information about a feature within the context of an installation session.

4260

</summary>

4261

</member>

4262

4263

4264

Calculates the disk space required by the feature and its selected children and parent features.

4265

</summary>

4266

<param name="includeParents">If true, the parent features are included in the cost.</param>

4267

<param name="includeChildren">If true, the child features are included in the cost.</param>

4268

<param name="installState">Specifies the installation state.</param>

4269

<returns>The disk space requirement in bytes.</returns>

4270

4271

Win32 MSI API:

4272

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeaturecost.asp">MsiGetFeatureCost</a>

4273

</remarks>

4274

</member>

4275

4276

4277

Gets the name of the feature (primary key in the Feature table).

4278

</summary>

4279

</member>

4280

4281

4282

Gets the current install state of the feature.

4283

</summary>

4284

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

4285

<exception cref="T:System.ArgumentException">an unknown feature was requested</exception>

4286

4287

Win32 MSI API:

4288

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeaturestate.asp">MsiGetFeatureState</a>

4289

</remarks>

4290

</member>

4291

4292

4293

Gets or sets the action state of the feature.

4294

</summary>

4295

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

4296

<exception cref="T:System.ArgumentException">an unknown feature was requested</exception>

4297

4298

When changing the feature action, the action state of all the Components linked to the changed

4299

Feature records are also updated appropriately, based on the new feature Select state.

4300

All Features can be configured at once by specifying the keyword ALL instead of a specific feature name.

4301

4302

Win32 MSI APIs:

4303

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeaturestate.asp">MsiGetFeatureState</a>,

4304

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetfeaturestate.asp">MsiSetFeatureState</a>

4305

</remarks>

4306

</member>

4307

4308

4309

Gets a list of valid installation states for the feature.

4310

</summary>

4311

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

4312

<exception cref="T:System.ArgumentException">an unknown feature was requested</exception>

4313

4314

Win32 MSI API:

4315

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeaturevalidstates.asp">MsiGetFeatureValidStates</a>

4316

</remarks>

4317

</member>

4318

4319

4320

Gets or sets the attributes of the feature.

4321

</summary>

4322

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

4323

<exception cref="T:System.ArgumentException">an unknown feature was requested</exception>

4324

4325

Win32 MSI APIs:

4326

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeatureinfo.asp">MsiGetFeatureInfo</a>,

4327

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetfeatureattributes.asp">MsiSetFeatureAttributes</a>

4328

4329

Since the lpAttributes paramter of

4330

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeatureinfo.asp">MsiGetFeatureInfo</a>

4331

does not contain an equivalent flag for <see cref="F:Microsoft.Deployment.WindowsInstaller.FeatureAttributes.UIDisallowAbsent"/>, this flag will

4332

not be retrieved.

4333

4334

Since the dwAttributes parameter of

4335

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetfeatureattributes.asp">MsiSetFeatureAttributes</a>

4336

does not contain an equivalent flag for <see cref="F:Microsoft.Deployment.WindowsInstaller.FeatureAttributes.UIDisallowAbsent"/>, the presence

4337

of this flag will be ignored.

4338

</remarks>

4339

</member>

4340

4341

4342

Gets the title of the feature.

4343

</summary>

4344

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

4345

<exception cref="T:System.ArgumentException">an unknown feature was requested</exception>

4346

4347

Win32 MSI API:

4348

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeatureinfo.asp">MsiGetFeatureInfo</a>

4349

</remarks>

4350

</member>

4351

4352

4353

Gets the description of the feature.

4354

</summary>

4355

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

4356

<exception cref="T:System.ArgumentException">an unknown feature was requested</exception>

4357

4358

Win32 MSI API:

4359

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeatureinfo.asp">MsiGetFeatureInfo</a>

4360

</remarks>

4361

</member>

4362

4363

4364

Represents an instance of a feature of an installed product.

4365

</summary>

4366

</member>

4367

4368

4369

Creates a new FeatureInstallation instance for a feature of a product.

4370

</summary>

4371

<param name="featureName">feature name</param>

4372

<param name="productCode">ProductCode GUID</param>

4373

</member>

4374

4375

4376

Gets the name of the feature.

4377

</summary>

4378

</member>

4379

4380

4381

Gets the installed state of the feature.

4382

</summary>

4383

4384

Win32 MSI API:

4385

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiqueryfeaturestate.asp">MsiQueryFeatureState</a>

4386

</remarks>

4387

</member>

4388

4389

4390

Gets the parent of the feature, or null if the feature has no parent (it is a root feature).

4391

</summary>

4392

4393

Invocation of this property may be slightly costly for products with many features,

4394

because it involves an enumeration of all the features in the product.

4395

</remarks>

4396

</member>

4397

4398

4399

Gets the usage metrics for the feature.

4400

</summary>

4401

4402

If no usage metrics are recorded, the <see cref="P:Microsoft.Deployment.WindowsInstaller.FeatureInstallation.UsageData.UseCount"/> value is 0.

4403

4404

Win32 MSI API:

4405

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetfeatureusage.asp">MsiGetFeatureUsage</a>

4406

</remarks>

4407

</member>

4408

4409

4410

Holds data about the usage of a feature.

4411

</summary>

4412

</member>

4413

4414

4415

Gets count of the number of times the feature has been used.

4416

</summary>

4417

</member>

4418

4419

4420

Gets the date the feature was last used.

4421

</summary>

4422

</member>

4423

4424

4425

[MSI 4.5] Interface for an embedded external user interface for an installation.

4426

</summary>

4427

4428

Classes which implement this interface must have a public constructor that takes no parameters.

4429

</remarks>

4430

</member>

4431

4432

4433

Initializes the embedded UI.

4434

</summary>

4435

<param name="session">Handle to the installer which can be used to get and set properties.

4436

The handle is only valid for the duration of this method call.</param>

4437

<param name="resourcePath">Path to the directory that contains all the files from the MsiEmbeddedUI table.</param>

4438

<param name="internalUILevel">On entry, contains the current UI level for the installation. After this

4439

method returns, the installer resets the UI level to the returned value of this parameter.</param>

4440

<returns>True if the embedded UI was successfully initialized; false if the installation

4441

should continue without the embedded UI.</returns>

4442

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">The installation was canceled by the user.</exception>

4443

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The embedded UI failed to initialize and

4444

causes the installation to fail.</exception>

4445

4446

Win32 MSI API:

4447

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/initializeembeddedui.asp">InitializeEmbeddedUI</a>

4448

</remarks>

4449

</member>

4450

4451

4452

Processes information and progress messages sent to the user interface.

4453

</summary>

4454

<param name="messageType">Message type.</param>

4455

<param name="messageRecord">Record that contains message data.</param>

4456

<param name="buttons">Message buttons.</param>

4457

<param name="icon">Message box icon.</param>

4458

<param name="defaultButton">Message box default button.</param>

4459

<returns>Result of processing the message.</returns>

4460

4461

Win32 MSI API:

4462

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/embeddeduihandler.asp">EmbeddedUIHandler</a>

4463

</remarks>

4464

</member>

4465

4466

4467

Shuts down the embedded UI at the end of the installation.

4468

</summary>

4469

4470

If the installation was canceled during initialization, this method will not be called.

4471

If the installation was canceled or failed at any later point, this method will be called at the end.

4472

4473

Win32 MSI API:

4474

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/shutdownembeddedui.asp">ShutdownEmbeddedUI</a>

4475

</remarks>

4476

</member>

4477

4478

4479

Subclasses of this abstract class represent a unique instance of a

4480

registered product or patch installation.

4481

</summary>

4482

</member>

4483

4484

4485

Gets the user security identifier (SID) under which this product or patch

4486

installation is available.

4487

</summary>

4488

</member>

4489

4490

4491

Gets the user context of this product or patch installation.

4492

</summary>

4493

</member>

4494

4495

4496

Gets the source list of this product or patch installation.

4497

</summary>

4498

</member>

4499

4500

4501

Gets a value indicating whether this product or patch is installed on the current system.

4502

</summary>

4503

</member>

4504

4505

4506

Gets a property about the product or patch installation.

4507

</summary>

4508

<param name="propertyName">Name of the property being retrieved.</param>

4509

4510

</member>

4511

4512

4513

Represents a per-drive disk space cost for an installation.

4514

</summary>

4515

</member>

4516

4517

4518

Creates a new InstallCost object.

4519

</summary>

4520

<param name="driveName">name of the drive this cost data applies to</param>

4521

<param name="cost">installation cost on this drive, as a number of bytes</param>

4522

<param name="tempCost">temporary disk space required on this drive, as a number of bytes</param>

4523

</member>

4524

4525

4526

The name of the drive this cost data applies to.

4527

</summary>

4528

</member>

4529

4530

4531

The installation cost on this drive, as a number of bytes.

4532

</summary>

4533

</member>

4534

4535

4536

The temporary disk space required on this drive, as a number of bytes.

4537

</summary>

4538

4539

This temporary space requirement is space needed only for the duration

4540

of the installation, over the final footprint on disk.

4541

</remarks>

4542

</member>

4543

4544

4545

Receives an exception from

4546

4547

indicating the reason a particular patch is not applicable to a product.

4548

</summary>

4549

<param name="patch">MSP file path, XML file path, or XML blob that was passed to

4550

4551

<param name="exception">exception indicating the reason the patch is not applicable</param>

4552

4553

If <paramref name="exception"/> is an <see cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException"/> or subclass, then

4554

its <see cref="P:Microsoft.Deployment.WindowsInstaller.InstallerException.ErrorCode"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.InstallerException.Message"/>

4555

properties will indicate a more specific reason the patch was not applicable.

4556

4557

The <paramref name="exception"/> could also be a FileNotFoundException if the

4558

patch string was a file path.

4559

</remarks>

4560

</member>

4561

4562

4563

[MSI 4.5] Handle to a multi-session install transaction.

4564

</summary>

4565

4566

Win32 MSI APIs:

4567

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msibegintransaction.asp">MsiBeginTransaction</a>

4568

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msijointransaction.asp">MsiJoinTransaction</a>

4569

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiendtransaction.asp">MsiEndTransaction</a>

4570

</remarks>

4571

</member>

4572

4573

4574

[MSI 4.5] Begins transaction processing of a multi-package installation.

4575

</summary>

4576

<param name="name">Name of the multi-package installation.</param>

4577

<param name="attributes">Select optional behavior when beginning the transaction.</param>

4578

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The transaction could not be initialized.</exception>

4579

4580

Win32 MSI API:

4581

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msibegintransaction.asp">MsiBeginTransaction</a>

4582

</remarks>

4583

</member>

4584

4585

4586

Internal constructor.

4587

</summary>

4588

4589

The second parameter is an array in order to receive multiple values from the initialization method.

4590

</remarks>

4591

</member>

4592

4593

4594

Creates a new Transaction object from an integer handle.

4595

</summary>

4596

<param name="handle">Integer transaction handle</param>

4597

<param name="ownsHandle">true to close the handle when this object is disposed</param>

4598

</member>

4599

4600

4601

Makes the current process the owner of the multi-package installation transaction.

4602

</summary>

4603

<param name="attributes">Select optional behavior when joining the transaction.</param>

4604

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">The transaction handle is not valid.</exception>

4605

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The transaction could not be joined.</exception>

4606

4607

Win32 MSI API:

4608

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msijointransaction.asp">MsiJoinTransaction</a>

4609

</remarks>

4610

</member>

4611

4612

4613

Ends the install transaction and commits all changes to the system belonging to the transaction.

4614

</summary>

4615

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The transaction could not be committed.</exception>

4616

4617

Runs any Commit Custom Actions and commits to the system any changes to Win32 or common language

4618

runtime assemblies. Deletes the rollback script, and after using this option, the transaction's

4619

changes can no longer be undone with a Rollback Installation.

4620

4621

This method can only be called by the current owner of the transaction.

4622

4623

Win32 MSI API:

4624

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiendtransaction.asp">MsiEndTransaction</a>

4625

</remarks>

4626

</member>

4627

4628

4629

Ends the install transaction and undoes changes to the system belonging to the transaction.

4630

</summary>

4631

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The transaction could not be rolled back.</exception>

4632

4633

This method can only be called by the current owner of the transaction.

4634

4635

Win32 MSI API:

4636

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiendtransaction.asp">MsiEndTransaction</a>

4637

</remarks>

4638

</member>

4639

4640

4641

Gets the name of the transaction.

4642

</summary>

4643

</member>

4644

4645

4646

Notifies listeners when the process that owns the transaction changed.

4647

</summary>

4648

</member>

4649

4650

4651

Represents a media disk source of a product or a patch.

4652

</summary>

4653

</member>

4654

4655

4656

Creates a new media disk.

4657

</summary>

4658

4659

4660

4661

</member>

4662

4663

4664

Gets or sets the disk id of the media disk.

4665

</summary>

4666

</member>

4667

4668

4669

Gets or sets the volume label of the media disk.

4670

</summary>

4671

</member>

4672

4673

4674

Gets or sets the disk prompt of the media disk.

4675

</summary>

4676

</member>

4677

4678

4679

The Patch object represents a unique instance of a patch that has been

4680

registered or applied.

4681

</summary>

4682

</member>

4683

4684

4685

Enumerates patch installations based on certain criteria.

4686

</summary>

4687

<param name="patchCode">PatchCode (GUID) of the patch to be enumerated. Only

4688

instances of patches within the scope of the context specified by the

4689

<paramref name="userSid"/> and <paramref name="context"/> parameters will be

4690

enumerated. This parameter may be set to null to enumerate all patches in the specified

4691

context.</param>

4692

<param name="targetProductCode">ProductCode (GUID) product whose patches are to be

4693

enumerated. If non-null, patch enumeration is restricted to instances of this product

4694

within the specified context. If null, the patches for all products under the specified

4695

context are enumerated.</param>

4696

<param name="userSid">Specifies a security identifier (SID) that restricts the context

4697

of enumeration. A SID value other than s-1-1-0 is considered a user SID and restricts

4698

enumeration to the current user or any user in the system. The special SID string

4699

s-1-1-0 (Everyone) specifies enumeration across all users in the system. This parameter

4700

can be set to null to restrict the enumeration scope to the current user. When

4701

<paramref name="installContext"/> is set to the machine context only,

4702

4703

<param name="context">Specifies the user context.</param>

4704

<param name="states">The <see cref="T:Microsoft.Deployment.WindowsInstaller.PatchStates"/> of patches to return.</param>

4705

4706

Win32 MSI APIs:

4707

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumpatchesex.asp">MsiEnumPatchesEx</a>

4708

</remarks>

4709

</member>

4710

4711

4712

Creates a new object for accessing information about a patch installation on the current system.

4713

</summary>

4714

<param name="patchCode">Patch code (GUID) of the patch.</param>

4715

<param name="productCode">ProductCode (GUID) the patch has been applied to.

4716

This parameter may be null for patches that are registered only and not yet

4717

applied to any product.</param>

4718

4719

All available user contexts will be queried.

4720

</remarks>

4721

</member>

4722

4723

4724

Creates a new object for accessing information about a patch installation on the current system.

4725

</summary>

4726

<param name="patchCode">Registered patch code (GUID) of the patch.</param>

4727

<param name="productCode">ProductCode (GUID) the patch has been applied to.

4728

This parameter may be null for patches that are registered only and not yet

4729

applied to any product.</param>

4730

<param name="userSid">The specific user, when working in a user context. This

4731

parameter may be null to indicate the current user. The parameter must be null

4732

when working in a machine context.</param>

4733

<param name="context">The user context. The calling process must have administrative

4734

privileges to get information for a product installed for a user other than the

4735

current user.</param>

4736

4737

If the <paramref name="productCode"/> is null, the Patch object may

4738

only be used to read and update the patch's SourceList information.

4739

</remarks>

4740

</member>

4741

4742

4743

Enumerates all patch installations on the system.

4744

</summary>

4745

<returns>Enumeration of patch objects.</returns>

4746

4747

Win32 MSI API:

4748

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumpatches.asp">MsiEnumPatches</a>

4749

</remarks>

4750

</member>

4751

4752

4753

Gets the patch code (GUID) of the patch.

4754

</summary>

4755

</member>

4756

4757

4758

Gets the ProductCode (GUID) of the product.

4759

</summary>

4760

</member>

4761

4762

4763

Gets a value indicating whether this patch is currently installed.

4764

</summary>

4765

</member>

4766

4767

4768

Gets a value indicating whether this patch is marked as obsolte.

4769

</summary>

4770

</member>

4771

4772

4773

Gets a value indicating whether this patch is present but has been

4774

superseded by a more recent installed patch.

4775

</summary>

4776

</member>

4777

4778

4779

Gets the installation state of this instance of the patch.

4780

</summary>

4781

<exception cref="T:System.ArgumentException">An unknown patch was requested</exception>

4782

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

4783

</member>

4784

4785

4786

Gets the cached patch file that the product uses.

4787

</summary>

4788

</member>

4789

4790

4791

Gets the set of patch transforms that the last patch

4792

installation applied to the product.

4793

</summary>

4794

4795

This value may not be available for per-user, non-managed applications

4796

if the user is not logged on.

4797

</remarks>

4798

</member>

4799

4800

4801

Gets the date and time when the patch is applied to the product.

4802

</summary>

4803

</member>

4804

4805

4806

True patch is marked as possible to uninstall from the product.

4807

</summary>

4808

4809

Even if this property is true, the installer can still block the

4810

uninstallation if this patch is required by another patch that

4811

cannot be uninstalled.

4812

</remarks>

4813

</member>

4814

4815

4816

Get the registered display name for the patch.

4817

</summary>

4818

</member>

4819

4820

4821

Gets the registered support information URL for the patch.

4822

</summary>

4823

</member>

4824

4825

4826

Gets information about a specific patch installation.

4827

</summary>

4828

<param name="propertyName">The property being retrieved; see remarks for valid properties.</param>

4829

<returns>The property value, or an empty string if the property is not set for the patch.</returns>

4830

<exception cref="T:System.ArgumentOutOfRangeException">An unknown patch or property was requested</exception>

4831

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

4832

4833

Win32 MSI APIs:

4834

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetpatchinfo.asp">MsiGetPatchInfo</a>,

4835

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetpatchinfoex.asp">MsiGetPatchInfoEx</a>

4836

</remarks>

4837

</member>

4838

4839

4840

Represents a unique instance of a product that

4841

is either advertised, installed or unknown.

4842

</summary>

4843

</member>

4844

4845

4846

Gets the set of all products with a specified upgrade code. This method lists the

4847

currently installed and advertised products that have the specified UpgradeCode

4848

property in their Property table.

4849

</summary>

4850

<param name="upgradeCode">Upgrade code of related products</param>

4851

<returns>Enumeration of product codes</returns>

4852

4853

Win32 MSI API:

4854

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumrelatedproducts.asp">MsiEnumRelatedProducts</a>

4855

</remarks>

4856

</member>

4857

4858

4859

Enumerates product installations based on certain criteria.

4860

</summary>

4861

<param name="productCode">ProductCode (GUID) of the product instances to be enumerated. Only

4862

instances of products within the scope of the context specified by the

4863

<paramref name="userSid"/> and <paramref name="installContext"/> parameters will be

4864

enumerated. This parameter may be set to null to enumerate all products in the specified

4865

context.</param>

4866

<param name="userSid">Specifies a security identifier (SID) that restricts the context

4867

of enumeration. A SID value other than s-1-1-0 is considered a user SID and restricts

4868

enumeration to the current user or any user in the system. The special SID string

4869

s-1-1-0 (Everyone) specifies enumeration across all users in the system. This parameter

4870

can be set to null to restrict the enumeration scope to the current user. When

4871

<paramref name="context"/> is set to the machine context only,

4872

4873

<param name="context">Specifies the user context.</param>

4874

<returns>An enumeration of product objects for enumerated product instances.</returns>

4875

4876

Win32 MSI API:

4877

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumproductsex.asp">MsiEnumProductsEx</a>

4878

</remarks>

4879

</member>

4880

4881

4882

Creates a new object for accessing information about a product installation on the current system.

4883

</summary>

4884

<param name="productCode">ProductCode (GUID) of the product.</param>

4885

4886

All available user contexts will be queried.

4887

</remarks>

4888

</member>

4889

4890

4891

Creates a new object for accessing information about a product installation on the current system.

4892

</summary>

4893

<param name="productCode">ProductCode (GUID) of the product.</param>

4894

<param name="userSid">The specific user, when working in a user context. This

4895

parameter may be null to indicate the current user. The parameter must be null

4896

when working in a machine context.</param>

4897

<param name="context">The user context. The calling process must have administrative

4898

privileges to get information for a product installed for a user other than the

4899

current user.</param>

4900

</member>

4901

4902

4903

Gets the installed state for a product feature.

4904

</summary>

4905

<param name="feature">The feature being queried; identifier from the

4906

Feature table</param>

4907

<returns>Installation state of the feature for the product instance: either

4908

<see cref="F:Microsoft.Deployment.WindowsInstaller.InstallState.Local"/>, <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallState.Source"/>,

4909

or <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallState.Advertised"/>.</returns>

4910

4911

Win32 MSI APIs:

4912

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiqueryfeaturestate.asp">MsiQueryFeatureState</a>,

4913

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiqueryfeaturestateex.asp">MsiQueryFeatureStateEx</a>

4914

</remarks>

4915

</member>

4916

4917

4918

Gets the installed state for a product component.

4919

</summary>

4920

<param name="component">The component being queried; GUID of the component

4921

as found in the ComponentId column of the Component table.</param>

4922

<returns>Installation state of the component for the product instance: either

4923

4924

4925

Win32 MSI API:

4926

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiquerycomponnetstate.asp">MsiQueryComponentState</a>

4927

</remarks>

4928

</member>

4929

4930

4931

Obtains and stores the user information and product ID from an installation wizard.

4932

</summary>

4933

4934

This method is typically called by an application during the first run of the application. The application

4935

first gets the <see cref="P:Microsoft.Deployment.WindowsInstaller.ProductInstallation.ProductId"/> or <see cref="P:Microsoft.Deployment.WindowsInstaller.ProductInstallation.RegOwner"/>.

4936

If those properties are missing, the application calls CollectUserInfo.

4937

CollectUserInfo opens the product's installation package and invokes a wizard sequence that collects

4938

user information. Upon completion of the sequence, user information is registered. Since this API requires

4939

an authored user interface, the user interface level should be set to full by calling

4940

<see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.SetInternalUI(Microsoft.Deployment.WindowsInstaller.InstallUIOptions)"/> as <see cref="F:Microsoft.Deployment.WindowsInstaller.InstallUIOptions.Full"/>.

4941

4942

The CollectUserInfo method invokes a FirstRun dialog from the product installation database.

4943

4944

Win32 MSI API:

4945

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msicollectuserinfo.asp">MsiCollectUserInfo</a>

4946

</remarks>

4947

</member>

4948

4949

4950

Some products might write some invalid/nonstandard version strings to the registry.

4951

This method tries to get the best data it can.

4952

</summary>

4953

<param name="ver">Version string retrieved from the registry.</param>

4954

<returns>Version object, or null if the version string is completely invalid.</returns>

4955

</member>

4956

4957

4958

Enumerates all product installations on the system.

4959

</summary>

4960

<returns>An enumeration of product objects.</returns>

4961

4962

Win32 MSI API:

4963

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumproducts.asp">MsiEnumProducts</a>,

4964

</remarks>

4965

</member>

4966

4967

4968

Gets the set of published features for the product.

4969

</summary>

4970

<returns>Enumeration of published features for the product.</returns>

4971

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

4972

4973

Because features are not ordered, any new feature has an arbitrary index, meaning

4974

this property can return features in any order.

4975

4976

Win32 MSI API:

4977

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumfeatures.asp">MsiEnumFeatures</a>

4978

</remarks>

4979

</member>

4980

4981

4982

Gets the ProductCode (GUID) of the product.

4983

</summary>

4984

</member>

4985

4986

4987

Gets a value indicating whether this product is installed on the current system.

4988

</summary>

4989

</member>

4990

4991

4992

Gets a value indicating whether this product is advertised on the current system.

4993

</summary>

4994

</member>

4995

4996

4997

Checks whether the product is installed with elevated privileges. An application is called

4998

a "managed application" if elevated (system) privileges are used to install the application.

4999

</summary>

5000

<returns>True if the product is elevated; false otherwise</returns>

5001

5002

Note that this property does not take into account policies such as AlwaysInstallElevated,

5003

but verifies that the local system owns the product's registry data.

5004

</remarks>

5005

</member>

5006

5007

5008

Gets the source list of this product installation.

5009

</summary>

5010

</member>

5011

5012

5013

The support link.

5014

</summary>

5015

</member>

5016

5017

5018

The support telephone.

5019

</summary>

5020

</member>

5021

5022

5023

Date and time the product was installed.

5024

</summary>

5025

</member>

5026

5027

5028

The installed product name.

5029

</summary>

5030

</member>

5031

5032

5033

The installation location.

5034

</summary>

5035

</member>

5036

5037

5038

The installation source.

5039

</summary>

5040

</member>

5041

5042

5043

The local cached package.

5044

</summary>

5045

</member>

5046

5047

5048

The publisher.

5049

</summary>

5050

</member>

5051

5052

5053

URL about information.

5054

</summary>

5055

</member>

5056

5057

5058

The URL update information.

5059

</summary>

5060

</member>

5061

5062

5063

The product version.

5064

</summary>

5065

</member>

5066

5067

5068

The product identifier.

5069

</summary>

5070

5071

For more information, see

5072

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/productid.asp">ProductID</a>

5073

</remarks>

5074

</member>

5075

5076

5077

The company that is registered to use the product.

5078

</summary>

5079

</member>

5080

5081

5082

The owner who is registered to use the product.

5083

</summary>

5084

</member>

5085

5086

5087

Transforms.

5088

</summary>

5089

</member>

5090

5091

5092

Product language.

5093

</summary>

5094

</member>

5095

5096

5097

Human readable product name.

5098

</summary>

5099

</member>

5100

5101

5102

True if the product is advertised per-machine;

5103

false if it is per-user or not advertised.

5104

</summary>

5105

</member>

5106

5107

5108

Identifier of the package that a product is installed from.

5109

</summary>

5110

</member>

5111

5112

5113

Version of the advertised product.

5114

</summary>

5115

</member>

5116

5117

5118

Primary icon for the package.

5119

</summary>

5120

</member>

5121

5122

5123

Name of the installation package for the advertised product.

5124

</summary>

5125

</member>

5126

5127

5128

True if the advertised product can be serviced by

5129

non-administrators without elevation.

5130

</summary>

5131

</member>

5132

5133

5134

Gets information about an installation of a product.

5135

</summary>

5136

<param name="propertyName">Name of the property being retrieved.</param>

5137

<exception cref="T:System.ArgumentOutOfRangeException">An unknown product or property was requested</exception>

5138

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The installer configuration data is corrupt</exception>

5139

5140

Win32 MSI APIs:

5141

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetproductinfo.asp">MsiGetProductInfo</a>,

5142

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetproductinfoex.asp">MsiGetProductInfoEx</a>

5143

</remarks>

5144

</member>

5145

5146

5147

The Record object is a container for holding and transferring a variable number of values.

5148

Fields within the record are numerically indexed and can contain strings, integers, streams,

5149

and null values. Record fields are indexed starting with 1. Field 0 is a special format field.

5150

</summary>

5151

5152

Most methods on the Record class have overloads that allow using either a number

5153

or a name to designate a field. However note that field names only exist when the

5154

Record is directly returned from a query on a database. For other records, attempting

5155

to access a field by name will result in an InvalidOperationException.

5156

</remarks>

5157

</member>

5158

5159

5160

Creates a new record object with the requested number of fields.

5161

</summary>

5162

<param name="fieldCount">Required number of fields, which may be 0.

5163

The maximum number of fields in a record is limited to 65535.</param>

5164

5165

The Record object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

5166

It is best that the handle be closed manually as soon as it is no longer

5167

needed, as leaving lots of unused handles open can degrade performance.

5168

5169

Win32 MSI API:

5170

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msicreaterecord.asp">MsiCreateRecord</a>

5171

</remarks>

5172

</member>

5173

5174

5175

Creates a new record object, providing values for an arbitrary number of fields.

5176

</summary>

5177

<param name="fields">The values of the record fields. The parameters should be of type Int16, Int32 or String</param>

5178

5179

The Record object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

5180

It is best that the handle be closed manually as soon as it is no longer

5181

needed, as leaving lots of unused handles open can degrade performance.

5182

5183

Win32 MSI API:

5184

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msicreaterecord.asp">MsiCreateRecord</a>

5185

</remarks>

5186

</member>

5187

5188

5189

Creates a new Record object from an integer record handle.

5190

</summary>

5191

5192

This method is only provided for interop purposes. A Record object

5193

should normally be obtained by calling <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/>

5194

other methods.

5195

The handle will be closed when this object is disposed or finalized.

5196

</remarks>

5197

<param name="handle">Integer record handle</param>

5198

<param name="ownsHandle">true to close the handle when this object is disposed or finalized</param>

5199

</member>

5200

5201

5202

Sets all fields in a record to null.

5203

</summary>

5204

5205

Win32 MSI API:

5206

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordcleardata.asp">MsiRecordClearData</a>

5207

</remarks>

5208

</member>

5209

5210

5211

Reports whether a record field is null.

5212

</summary>

5213

<param name="field">Specifies the field to check.</param>

5214

<returns>True if the field is null, false otherwise.</returns>

5215

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5216

number of fields in the Record.</exception>

5217

5218

Win32 MSI API:

5219

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordisnull.asp">MsiRecordIsNull</a>

5220

</remarks>

5221

</member>

5222

5223

5224

Reports whether a record field is null.

5225

</summary>

5226

<param name="fieldName">Specifies the field to check.</param>

5227

<returns>True if the field is null, false otherwise.</returns>

5228

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5229

of the named fields in the Record.</exception>

5230

</member>

5231

5232

5233

Gets the length of a record field. The count does not include the terminating null.

5234

</summary>

5235

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5236

number of fields in the Record.</exception>

5237

5238

The returned data size is 0 if the field is null, non-existent,

5239

or an internal object pointer. The method also returns 0 if the handle is not a valid

5240

Record handle.

5241

5242

If the data is in integer format, the property returns 2 or 4.

5243

5244

If the data is in string format, the property returns the character count

5245

(not including the NULL terminator).

5246

5247

If the data is in stream format, the property returns the byte count.

5248

5249

Win32 MSI API:

5250

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecorddatasize.asp">MsiRecordDataSize</a>

5251

</remarks>

5252

</member>

5253

5254

5255

Gets the length of a record field. The count does not include the terminating null.

5256

</summary>

5257

<param name="fieldName">Specifies the field to check.</param>

5258

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5259

of the named fields in the Record.</exception>

5260

<remarks>The returned data size is 0 if the field is null, non-existent,

5261

or an internal object pointer. The method also returns 0 if the handle is not a valid

5262

Record handle.

5263

5264

If the data is in integer format, the property returns 2 or 4.

5265

5266

If the data is in string format, the property returns the character count

5267

(not including the NULL terminator).

5268

5269

If the data is in stream format, the property returns the byte count.

5270

</remarks>

5271

</member>

5272

5273

5274

Gets a field value as an integer.

5275

</summary>

5276

<param name="field">Specifies the field to retrieve.</param>

5277

<returns>Integer value of the field, or 0 if the field is null.</returns>

5278

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5279

number of fields in the Record.</exception>

5280

5281

Win32 MSI API:

5282

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordgetinteger.asp">MsiRecordGetInteger</a>

5283

</remarks>

5284

5285

</member>

5286

5287

5288

Gets a field value as an integer.

5289

</summary>

5290

<param name="fieldName">Specifies the field to retrieve.</param>

5291

<returns>Integer value of the field, or 0 if the field is null.</returns>

5292

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5293

of the named fields in the Record.</exception>

5294

5295

</member>

5296

5297

5298

Gets a field value as an integer.

5299

</summary>

5300

<param name="field">Specifies the field to retrieve.</param>

5301

<returns>Integer value of the field, or null if the field is null.</returns>

5302

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5303

number of fields in the Record.</exception>

5304

5305

Win32 MSI API:

5306

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordgetinteger.asp">MsiRecordGetInteger</a>

5307

</remarks>

5308

5309

</member>

5310

5311

5312

Gets a field value as an integer.

5313

</summary>

5314

<param name="fieldName">Specifies the field to retrieve.</param>

5315

<returns>Integer value of the field, or null if the field is null.</returns>

5316

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5317

of the named fields in the Record.</exception>

5318

5319

</member>

5320

5321

5322

Sets the value of a field to an integer.

5323

</summary>

5324

<param name="field">Specifies the field to set.</param>

5325

<param name="value">new value of the field</param>

5326

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5327

number of fields in the Record.</exception>

5328

5329

Win32 MSI API:

5330

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordsetinteger.asp">MsiRecordSetInteger</a>

5331

</remarks>

5332

5333

</member>

5334

5335

5336

Sets the value of a field to an integer.

5337

</summary>

5338

<param name="fieldName">Specifies the field to set.</param>

5339

<param name="value">new value of the field</param>

5340

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5341

of the named fields in the Record.</exception>

5342

5343

</member>

5344

5345

5346

Sets the value of a field to a nullable integer.

5347

</summary>

5348

<param name="field">Specifies the field to set.</param>

5349

<param name="value">new value of the field</param>

5350

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5351

number of fields in the Record.</exception>

5352

5353

Win32 MSI API:

5354

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordsetinteger.asp">MsiRecordSetInteger</a>

5355

</remarks>

5356

5357

</member>

5358

5359

5360

Sets the value of a field to a nullable integer.

5361

</summary>

5362

<param name="fieldName">Specifies the field to set.</param>

5363

<param name="value">new value of the field</param>

5364

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5365

of the named fields in the Record.</exception>

5366

5367

</member>

5368

5369

5370

Gets a field value as a string.

5371

</summary>

5372

<param name="field">Specifies the field to retrieve.</param>

5373

<returns>String value of the field, or an empty string if the field is null.</returns>

5374

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5375

number of fields in the Record.</exception>

5376

5377

Win32 MSI API:

5378

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordgetstring.asp">MsiRecordGetString</a>

5379

</remarks>

5380

</member>

5381

5382

5383

Gets a field value as a string.

5384

</summary>

5385

<param name="fieldName">Specifies the field to retrieve.</param>

5386

<returns>String value of the field, or an empty string if the field is null.</returns>

5387

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5388

of the named fields in the Record.</exception>

5389

</member>

5390

5391

5392

Sets the value of a field to a string.

5393

</summary>

5394

<param name="field">Specifies the field to set.</param>

5395

<param name="value">new value of the field</param>

5396

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5397

number of fields in the Record.</exception>

5398

5399

Win32 MSI API:

5400

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordsetstring.asp">MsiRecordSetString</a>

5401

</remarks>

5402

</member>

5403

5404

5405

Sets the value of a field to a string.

5406

</summary>

5407

<param name="fieldName">Specifies the field to set.</param>

5408

<param name="value">new value of the field</param>

5409

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5410

of the named fields in the Record.</exception>

5411

</member>

5412

5413

5414

Reads a record stream field into a file.

5415

</summary>

5416

<param name="field">Specifies the field of the Record to get.</param>

5417

<param name="filePath">Specifies the path to the file to contain the stream.</param>

5418

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5419

number of fields in the Record.</exception>

5420

<exception cref="T:System.NotSupportedException">Attempt to extract a storage from a database open

5421

in read-write mode, or from a database without an associated file path</exception>

5422

5423

This method is capable of directly extracting substorages. To do so, first select both the

5424

`Name` and `Data` column of the `_Storages` table, then get the stream of the `Data` field.

5425

However, substorages may only be extracted from a database that is open in read-only mode.

5426

5427

Win32 MSI API:

5428

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordreadstream.asp">MsiRecordReadStream</a>

5429

</remarks>

5430

</member>

5431

5432

5433

Reads a record stream field into a file.

5434

</summary>

5435

<param name="fieldName">Specifies the field of the Record to get.</param>

5436

<param name="filePath">Specifies the path to the file to contain the stream.</param>

5437

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5438

of the named fields in the Record.</exception>

5439

<exception cref="T:System.NotSupportedException">Attempt to extract a storage from a database open

5440

in read-write mode, or from a database without an associated file path</exception>

5441

5442

This method is capable of directly extracting substorages. To do so, first select both the

5443

`Name` and `Data` column of the `_Storages` table, then get the stream of the `Data` field.

5444

However, substorages may only be extracted from a database that is open in read-only mode.

5445

</remarks>

5446

</member>

5447

5448

5449

Gets a record stream field.

5450

</summary>

5451

<param name="field">Specifies the field of the Record to get.</param>

5452

<returns>A Stream that reads the field data.</returns>

5453

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5454

number of fields in the Record.</exception>

5455

5456

This method is not capable of reading substorages. To extract a substorage,

5457

use <see cref="M:Microsoft.Deployment.WindowsInstaller.Record.GetStream(System.Int32,System.String)"/>.

5458

5459

Win32 MSI API:

5460

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordreadstream.asp">MsiRecordReadStream</a>

5461

</remarks>

5462

</member>

5463

5464

5465

Gets a record stream field.

5466

</summary>

5467

<param name="fieldName">Specifies the field of the Record to get.</param>

5468

<returns>A Stream that reads the field data.</returns>

5469

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5470

of the named fields in the Record.</exception>

5471

5472

This method is not capable of reading substorages. To extract a substorage,

5473

use <see cref="M:Microsoft.Deployment.WindowsInstaller.Record.GetStream(System.String,System.String)"/>.

5474

</remarks>

5475

</member>

5476

5477

5478

Sets a record stream field from a file. Stream data cannot be inserted into temporary fields.

5479

</summary>

5480

<param name="field">Specifies the field of the Record to set.</param>

5481

<param name="filePath">Specifies the path to the file containing the stream.</param>

5482

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5483

number of fields in the Record.</exception>

5484

5485

The contents of the specified file are read into a stream object. The stream persists if

5486

the Record is inserted into the Database and the Database is committed.

5487

5488

To reset the stream to its beginning you must pass in null for filePath.

5489

Do not pass an empty string, "", to reset the stream.

5490

5491

Setting a stream with this method is more efficient than setting a field to a

5492

FileStream object.

5493

5494

Win32 MSI API:

5495

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordsetstream.asp">MsiRecordsetStream</a>

5496

</remarks>

5497

</member>

5498

5499

5500

Sets a record stream field from a file. Stream data cannot be inserted into temporary fields.

5501

</summary>

5502

<param name="fieldName">Specifies the field name of the Record to set.</param>

5503

<param name="filePath">Specifies the path to the file containing the stream.</param>

5504

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5505

of the named fields in the Record.</exception>

5506

5507

The contents of the specified file are read into a stream object. The stream persists if

5508

the Record is inserted into the Database and the Database is committed.

5509

To reset the stream to its beginning you must pass in null for filePath.

5510

Do not pass an empty string, "", to reset the stream.

5511

5512

Setting a stream with this method is more efficient than setting a field to a

5513

FileStream object.

5514

</remarks>

5515

</member>

5516

5517

5518

Sets a record stream field from a Stream object. Stream data cannot be inserted into temporary fields.

5519

</summary>

5520

<param name="field">Specifies the field of the Record to set.</param>

5521

<param name="stream">Specifies the stream data.</param>

5522

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5523

number of fields in the Record.</exception>

5524

5525

The stream persists if the Record is inserted into the Database and the Database is committed.

5526

5527

Win32 MSI API:

5528

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordsetstream.asp">MsiRecordsetStream</a>

5529

</remarks>

5530

</member>

5531

5532

5533

Sets a record stream field from a Stream object. Stream data cannot be inserted into temporary fields.

5534

</summary>

5535

<param name="fieldName">Specifies the field name of the Record to set.</param>

5536

<param name="stream">Specifies the stream data.</param>

5537

<exception cref="T:System.ArgumentOutOfRangeException">The field name does not match any

5538

of the named fields in the Record.</exception>

5539

5540

The stream persists if the Record is inserted into the Database and the Database is committed.

5541

</remarks>

5542

</member>

5543

5544

5545

Gets a formatted string representation of the Record.

5546

</summary>

5547

<returns>A formatted string representation of the Record.</returns>

5548

5549

If field 0 of the Record is set to a nonempty string, it is used to format the data in the Record.

5550

5551

Win32 MSI API:

5552

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiformatrecord.asp">MsiFormatRecord</a>

5553

</remarks>

5554

5555

5556

</member>

5557

5558

5559

Gets a formatted string representation of the Record, optionally using a Session to format properties.

5560

</summary>

5561

<param name="provider">an optional Session instance that will be used to lookup any

5562

properties in the Record's format string</param>

5563

<returns>A formatted string representation of the Record.</returns>

5564

5565

If field 0 of the Record is set to a nonempty string, it is used to format the data in the Record.

5566

5567

Win32 MSI API:

5568

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiformatrecord.asp">MsiFormatRecord</a>

5569

</remarks>

5570

5571

5572

</member>

5573

5574

5575

Gets a formatted string representation of the Record.

5576

</summary>

5577

<param name="format">String to be used to format the data in the Record,

5578

instead of the Record's format string.</param>

5579

<returns>A formatted string representation of the Record.</returns>

5580

5581

Win32 MSI API:

5582

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiformatrecord.asp">MsiFormatRecord</a>

5583

</remarks>

5584

</member>

5585

5586

5587

Gets a formatted string representation of the Record, optionally using a Session to format properties.

5588

</summary>

5589

<param name="format">String to be used to format the data in the Record,

5590

instead of the Record's format string.</param>

5591

<param name="provider">an optional Session instance that will be used to lookup any

5592

properties in the Record's format string</param>

5593

<returns>A formatted string representation of the Record.</returns>

5594

5595

Win32 MSI API:

5596

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiformatrecord.asp">MsiFormatRecord</a>

5597

</remarks>

5598

5599

5600

</member>

5601

5602

5603

IsFormatStringInvalid is set from several View methods that invalidate the FormatString

5604

and used to determine behavior during Record.ToString().

5605

</summary>

5606

</member>

5607

5608

5609

Gets the number of fields in a record.

5610

</summary>

5611

5612

Win32 MSI API:

5613

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordgetfieldcount.asp">MsiRecordGetFieldCount</a>

5614

</remarks>

5615

</member>

5616

5617

5618

Gets or sets field 0 of the Record, which is the format string.

5619

</summary>

5620

</member>

5621

5622

5623

Gets or sets a record field value.

5624

</summary>

5625

<param name="fieldName">Specifies the name of the field of the Record to get or set.</param>

5626

<exception cref="T:System.ArgumentOutOfRangeException">The name does not match any known field of the Record.</exception>

5627

5628

When getting a field, the type of the object returned depends on the type of the Record field.

5629

The object will be one of: Int16, Int32, String, Stream, or null.

5630

5631

When setting a field, the type of the object provided will be converted to match the View

5632

query that returned the record, or if Record was not returned from a view then the type of

5633

the object provided will determine the type of the Record field. The object should be one of:

5634

Int16, Int32, String, Stream, or null.

5635

</remarks>

5636

</member>

5637

5638

5639

Gets or sets a record field value.

5640

</summary>

5641

<param name="field">Specifies the field of the Record to get or set.</param>

5642

<exception cref="T:System.ArgumentOutOfRangeException">The field is less than 0 or greater than the

5643

number of fields in the Record.</exception>

5644

5645

Record fields are indexed starting with 1. Field 0 is a special format field.

5646

5647

When getting a field, the type of the object returned depends on the type of the Record field.

5648

The object will be one of: Int16, Int32, String, Stream, or null. If the Record was returned

5649

from a View, the type will match that of the field from the View query. Otherwise, the type

5650

will match the type of the last value set for the field.

5651

5652

When setting a field, the type of the object provided will be converted to match the View

5653

query that returned the Record, or if Record was not returned from a View then the type of

5654

the object provided will determine the type of the Record field. The object should be one of:

5655

Int16, Int32, String, Stream, or null.

5656

5657

The type-specific getters and setters are slightly more efficient than this property, since

5658

they don't have to do the extra work to infer the value's type every time.

5659

5660

Win32 MSI APIs:

5661

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordgetinteger.asp">MsiRecordGetInteger</a>,

5662

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordgetstring.asp">MsiRecordGetString</a>,

5663

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordsetinteger.asp">MsiRecordSetInteger</a>,

5664

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msirecordsetstring.asp">MsiRecordSetString</a>

5665

</remarks>

5666

</member>

5667

5668

5669

Assigns ID numbers to the MSI APIs that are remotable.

5670

</summary>

5671

5672

This enumeration MUST stay in sync with the

5673

unmanaged equivalent in RemoteMsiSession.h!

5674

</remarks>

5675

</member>

5676

5677

5678

Defines the signature of the native function

5679

in SfxCA.dll that implements the remoting call.

5680

</summary>

5681

</member>

5682

5683

5684

Redirects native API calls to either the normal NativeMethods class

5685

or to out-of-proc calls via the remoting channel.

5686

</summary>

5687

</member>

5688

5689

5690

Checks if the current process is using remoting to access the

5691

MSI session and database APIs.

5692

</summary>

5693

</member>

5694

5695

5696

Sets a delegate that is used to make remote API calls.

5697

</summary>

5698

5699

The implementation of this delegate is provided by the

5700

custom action host DLL.

5701

</remarks>

5702

</member>

5703

5704

5705

The Session object controls the installation process. It opens the

5706

install database, which contains the installation tables and data.

5707

</summary>

5708

5709

This object is associated with a standard set of action functions,

5710

each performing particular operations on data from one or more tables. Additional

5711

custom actions may be added for particular product installations. The basic engine

5712

function is a sequencer that fetches sequential records from a designated sequence

5713

table, evaluates any specified condition expression, and executes the designated

5714

action. Actions not recognized by the engine are deferred to the UI handler object

5715

for processing, usually dialog box sequences.

5716

5717

Note that only one Session object can be opened by a single process.

5718

</remarks>

5719

</member>

5720

5721

5722

Creates a new Session object from an integer session handle.

5723

</summary>

5724

<param name="handle">Integer session handle</param>

5725

<param name="ownsHandle">true to close the handle when this object is disposed or finalized</param>

5726

5727

This method is only provided for interop purposes. A Session object

5728

should normally be obtained by calling <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.OpenPackage(Microsoft.Deployment.WindowsInstaller.Database,System.Boolean)"/>

5729

or <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.OpenProduct(System.String)"/>.

5730

</remarks>

5731

</member>

5732

5733

5734

Performs any enabled logging operations and defers execution to the UI handler

5735

object associated with the engine.

5736

</summary>

5737

<param name="messageType">Type of message to be processed</param>

5738

<param name="record">Contains message-specific fields</param>

5739

<returns>A message-dependent return value</returns>

5740

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session or Record handle is invalid</exception>

5741

<exception cref="T:System.ArgumentOutOfRangeException">an invalid message kind is specified</exception>

5742

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

5743

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the message-handler failed for an unknown reason</exception>

5744

5745

Logging may be selectively enabled for the various message types.

5746

See the <see cref="M:Microsoft.Deployment.WindowsInstaller.Installer.EnableLog(Microsoft.Deployment.WindowsInstaller.InstallLogModes,System.String)"/> method.

5747

5748

If record field 0 contains a formatting string, it is used to format the data in

5749

the other fields. Else if the message is an error, warning, or user message, an attempt

5750

is made to find a message template in the Error table for the current database using the

5751

error number found in field 1 of the record for message types and return values.

5752

5753

The <paramref name="messageType"/> parameter may also include message-box flags from

5754

the following enumerations: System.Windows.Forms.MessageBoxButtons,

5755

System.Windows.Forms.MessageBoxDefaultButton, System.Windows.Forms.MessageBoxIcon. These

5756

flags can be combined with the InstallMessage with a bitwise OR.

5757

5758

Note, this method never returns Cancel or Error values. Instead, appropriate

5759

exceptions are thrown in those cases.

5760

5761

Win32 MSI API:

5762

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprocessmessage.asp">MsiProcessMessage</a>

5763

</remarks>

5764

</member>

5765

5766

5767

Writes a message to the log, if logging is enabled.

5768

</summary>

5769

<param name="msg">The line to be written to the log</param>

5770

5771

Win32 MSI API:

5772

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprocessmessage.asp">MsiProcessMessage</a>

5773

</remarks>

5774

</member>

5775

5776

5777

Writes a formatted message to the log, if logging is enabled.

5778

</summary>

5779

<param name="format">The line to be written to the log, containing 0 or more format specifiers</param>

5780

<param name="args">An array containing 0 or more objects to be formatted</param>

5781

5782

Win32 MSI API:

5783

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiprocessmessage.asp">MsiProcessMessage</a>

5784

</remarks>

5785

</member>

5786

5787

5788

Evaluates a logical expression containing symbols and values.

5789

</summary>

5790

<param name="condition">conditional expression</param>

5791

<returns>The result of the condition evaluation</returns>

5792

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5793

<exception cref="T:System.ArgumentNullException">the condition is null or empty</exception>

5794

<exception cref="T:System.InvalidOperationException">the conditional expression is invalid</exception>

5795

5796

Win32 MSI API:

5797

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msievaluatecondition.asp">MsiEvaluateCondition</a>

5798

</remarks>

5799

</member>

5800

5801

5802

Evaluates a logical expression containing symbols and values, specifying a default

5803

value to be returned in case the condition is empty.

5804

</summary>

5805

<param name="condition">conditional expression</param>

5806

<param name="defaultValue">value to return if the condition is empty</param>

5807

<returns>The result of the condition evaluation</returns>

5808

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5809

<exception cref="T:System.InvalidOperationException">the conditional expression is invalid</exception>

5810

5811

Win32 MSI API:

5812

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msievaluatecondition.asp">MsiEvaluateCondition</a>

5813

</remarks>

5814

</member>

5815

5816

5817

Formats a string containing installer properties.

5818

</summary>

5819

<param name="format">A format string containing property tokens</param>

5820

<returns>A formatted string containing property data</returns>

5821

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Record handle is invalid</exception>

5822

5823

Win32 MSI API:

5824

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiformatrecord.asp">MsiFormatRecord</a>

5825

</remarks>

5826

</member>

5827

5828

5829

Returns a formatted string from record data.

5830

</summary>

5831

<param name="record">Record object containing a template and data to be formatted.

5832

The template string must be set in field 0 followed by any referenced data parameters.</param>

5833

<returns>A formatted string containing the record data</returns>

5834

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Record handle is invalid</exception>

5835

5836

Win32 MSI API:

5837

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiformatrecord.asp">MsiFormatRecord</a>

5838

</remarks>

5839

</member>

5840

5841

5842

Returns a formatted string from record data using a specified format.

5843

</summary>

5844

<param name="record">Record object containing a template and data to be formatted</param>

5845

<param name="format">Format string to be used instead of field 0 of the Record</param>

5846

<returns>A formatted string containing the record data</returns>

5847

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Record handle is invalid</exception>

5848

5849

Win32 MSI API:

5850

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiformatrecord.asp">MsiFormatRecord</a>

5851

</remarks>

5852

</member>

5853

5854

5855

Retrieves product properties (not session properties) from the product database.

5856

</summary>

5857

<returns>Value of the property, or an empty string if the property is not set.</returns>

5858

5859

Note this is not the correct method for getting ordinary session properties. For that,

5860

see the indexer on the Session class.

5861

5862

Win32 MSI API:

5863

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetproductproperty.asp">MsiGetProductProperty</a>

5864

</remarks>

5865

</member>

5866

5867

5868

Checks to see if sufficient disk space is present for the current installation.

5869

</summary>

5870

<returns>True if there is sufficient disk space; false otherwise.</returns>

5871

5872

Win32 MSI API:

5873

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiverifydiskspace.asp">MsiVerifyDiskSpace</a>

5874

</remarks>

5875

</member>

5876

5877

5878

Gets the total disk space per drive required for the installation.

5879

</summary>

5880

<returns>A list of InstallCost structures, specifying the cost for each drive</returns>

5881

5882

Win32 MSI API:

5883

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msienumcomponentcosts.asp">MsiEnumComponentCosts</a>

5884

</remarks>

5885

</member>

5886

5887

5888

Gets the designated mode flag for the current install session.

5889

</summary>

5890

<param name="mode">The type of mode to be checked.</param>

5891

<returns>The value of the designated mode flag.</returns>

5892

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5893

<exception cref="T:System.ArgumentOutOfRangeException">an invalid mode flag was specified</exception>

5894

5895

Note that only the following run modes are available to read from

5896

a deferred custom action:<list type="bullet">

5897

5898

5899

5900

</list>

5901

5902

Win32 MSI API:

5903

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetmode.asp">MsiGetMode</a>

5904

</remarks>

5905

</member>

5906

5907

5908

Sets the designated mode flag for the current install session.

5909

</summary>

5910

5911

<param name="value">The desired value of the mode.</param>

5912

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5913

<exception cref="T:System.ArgumentOutOfRangeException">an invalid mode flag was specified</exception>

5914

<exception cref="T:System.InvalidOperationException">the mode cannot not be set</exception>

5915

5916

Win32 MSI API:

5917

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetmode.asp">MsiSetMode</a>

5918

</remarks>

5919

</member>

5920

5921

5922

Gets the full path to the designated folder on the source media or server image.

5923

</summary>

5924

<exception cref="T:System.ArgumentException">the folder was not found in the Directory table</exception>

5925

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5926

5927

Win32 MSI API:

5928

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetsourcepath.asp">MsiGetSourcePath</a>

5929

</remarks>

5930

</member>

5931

5932

5933

Gets the full path to the designated folder on the installation target drive.

5934

</summary>

5935

<exception cref="T:System.ArgumentException">the folder was not found in the Directory table</exception>

5936

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5937

5938

Win32 MSI API:

5939

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigettargetpath.asp">MsiGetTargetPath</a>

5940

</remarks>

5941

</member>

5942

5943

5944

Sets the full path to the designated folder on the installation target drive.

5945

</summary>

5946

<exception cref="T:System.ArgumentException">the folder was not found in the Directory table</exception>

5947

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5948

5949

Setting the target path of a directory changes the path specification for the directory

5950

in the in-memory Directory table. Also, the path specifications of all other path objects

5951

in the table that are either subordinate or equivalent to the changed path are updated

5952

to reflect the change. The properties for each affected path are also updated.

5953

5954

If an error occurs in this function, all updated paths and properties revert to

5955

their previous values. Therefore, it is safe to treat errors returned by this function

5956

as non-fatal.

5957

5958

Do not attempt to configure the target path if the components using those paths

5959

are already installed for the current user or for a different user. Check the

5960

ProductState property before setting the target path to determine if the product

5961

containing this component is installed.

5962

5963

Win32 MSI API:

5964

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisettargetpath.asp">MsiSetTargetPath</a>

5965

</remarks>

5966

</member>

5967

5968

5969

Sets the install level for the current installation to a specified value and

5970

recalculates the Select and Installed states for all features in the Feature

5971

table. Also sets the Action state of each component in the Component table based

5972

on the new level.

5973

</summary>

5974

<param name="installLevel">New install level</param>

5975

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5976

5977

The SetInstallLevel method sets the following:<list type="bullet">

5978

<item><description>The installation level for the current installation to a specified value</description></item>

5979

<item><description>The Select and Installed states for all features in the Feature table</description></item>

5980

<item><description>The Action state of each component in the Component table, based on the new level</description></item>

5981

</list>

5982

If 0 or a negative number is passed in the ilnstallLevel parameter,

5983

the current installation level does not change, but all features are still

5984

updated based on the current installation level.

5985

5986

Win32 MSI API:

5987

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetinstalllevel.asp">MsiSetInstallLevel</a>

5988

</remarks>

5989

</member>

5990

5991

5992

Executes a built-in action, custom action, or user-interface wizard action.

5993

</summary>

5994

<param name="action">Name of the action to execute. Case-sensitive.</param>

5995

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

5996

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

5997

5998

The DoAction method executes the action that corresponds to the name supplied. If the

5999

name is not recognized by the installer as a built-in action or as a custom action in

6000

the CustomAction table, the name is passed to the user-interface handler object, which

6001

can invoke a function or a dialog box. If a null action name is supplied, the installer

6002

uses the upper-case value of the ACTION property as the action to perform. If no property

6003

value is defined, the default action is performed, defined as "INSTALL".

6004

6005

Actions that update the system, such as the InstallFiles and WriteRegistryValues

6006

actions, cannot be run by calling MsiDoAction. The exception to this rule is if DoAction

6007

is called from a custom action that is scheduled in the InstallExecuteSequence table

6008

between the InstallInitialize and InstallFinalize actions. Actions that do not update the

6009

system, such as AppSearch or CostInitialize, can be called.

6010

6011

Win32 MSI API:

6012

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidoaction.asp">MsiDoAction</a>

6013

</remarks>

6014

</member>

6015

6016

6017

Executes a built-in action, custom action, or user-interface wizard action.

6018

</summary>

6019

<param name="action">Name of the action to execute. Case-sensitive.</param>

6020

<param name="actionData">Optional data to be passed to a deferred custom action.</param>

6021

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

6022

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

6023

6024

The DoAction method executes the action that corresponds to the name supplied. If the

6025

name is not recognized by the installer as a built-in action or as a custom action in

6026

the CustomAction table, the name is passed to the user-interface handler object, which

6027

can invoke a function or a dialog box. If a null action name is supplied, the installer

6028

uses the upper-case value of the ACTION property as the action to perform. If no property

6029

value is defined, the default action is performed, defined as "INSTALL".

6030

6031

Actions that update the system, such as the InstallFiles and WriteRegistryValues

6032

actions, cannot be run by calling MsiDoAction. The exception to this rule is if DoAction

6033

is called from a custom action that is scheduled in the InstallExecuteSequence table

6034

between the InstallInitialize and InstallFinalize actions. Actions that do not update the

6035

system, such as AppSearch or CostInitialize, can be called.

6036

6037

If the called action is a deferred, rollback, or commit custom action, then the supplied

6038

<paramref name="actionData"/> will be available via the <see cref="P:Microsoft.Deployment.WindowsInstaller.Session.CustomActionData"/>

6039

property of that custom action's session.

6040

6041

Win32 MSI API:

6042

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msidoaction.asp">MsiDoAction</a>

6043

</remarks>

6044

</member>

6045

6046

6047

Executes an action sequence described in the specified table.

6048

</summary>

6049

<param name="sequenceTable">Name of the table containing the action sequence.</param>

6050

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

6051

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallCanceledException">the user exited the installation</exception>

6052

6053

This method queries the specified table, ordering the actions by the numbers in the Sequence column.

6054

For each row retrieved, an action is executed, provided that any supplied condition expression does

6055

not evaluate to FALSE.

6056

6057

An action sequence containing any actions that update the system, such as the InstallFiles and

6058

WriteRegistryValues actions, cannot be run by calling DoActionSequence. The exception to this rule is if

6059

DoActionSequence is called from a custom action that is scheduled in the InstallExecuteSequence table

6060

between the InstallInitialize and InstallFinalize actions. Actions that do not update the system, such

6061

as AppSearch or CostInitialize, can be called.

6062

6063

Win32 MSI API:

6064

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisequence.asp">MsiSequence</a>

6065

</remarks>

6066

</member>

6067

6068

6069

Implements formatting for <see cref="T:Microsoft.Deployment.WindowsInstaller.Record"/> data.

6070

</summary>

6071

<param name="formatType">Type of format object to get.</param>

6072

<returns>The the current instance, if <paramref name="formatType"/> is the same type

6073

as the current instance; otherwise, null.</returns>

6074

</member>

6075

6076

6077

Closes the session handle. Also closes the active database handle, if it is open.

6078

After closing a handle, further method calls may throw an <see cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException"/>.

6079

</summary>

6080

<param name="disposing">If true, the method has been called directly

6081

or indirectly by a user's code, so managed and unmanaged resources will

6082

be disposed. If false, only unmanaged resources will be disposed.</param>

6083

</member>

6084

6085

6086

Throws an exception if the custom action is not able to access immedate session details.

6087

</summary>

6088

</member>

6089

6090

6091

Gets the Database for the install session.

6092

</summary>

6093

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

6094

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the Database cannot be accessed</exception>

6095

6096

Normally there is no need to close this Database object. The same object can be

6097

used throughout the lifetime of the Session, and it will be closed when the Session

6098

is closed.

6099

6100

Win32 MSI API:

6101

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetactivedatabase.asp">MsiGetActiveDatabase</a>

6102

</remarks>

6103

</member>

6104

6105

6106

Gets the numeric language ID used by the current install session.

6107

</summary>

6108

6109

Win32 MSI API:

6110

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetlanguage.asp">MsiGetLanguage</a>

6111

</remarks>

6112

</member>

6113

6114

6115

Gets or sets the string value of a named installer property, as maintained by the

6116

Session object in the in-memory Property table, or, if it is prefixed with a percent

6117

sign (%), the value of a system environment variable for the current process.

6118

</summary>

6119

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the Session handle is invalid</exception>

6120

6121

Win32 MSI APIs:

6122

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetproperty.asp">MsiGetProperty</a>,

6123

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisetproperty.asp">MsiSetProperty</a>

6124

</remarks>

6125

</member>

6126

6127

6128

Gets an accessor for components in the current session.

6129

</summary>

6130

</member>

6131

6132

6133

Gets an accessor for features in the current session.

6134

</summary>

6135

</member>

6136

6137

6138

Gets custom action data for the session that was supplied by the caller.

6139

</summary>

6140

6141

</member>

6142

6143

6144

Gets the (short) list of properties that are available from non-immediate custom actions.

6145

</summary>

6146

</member>

6147

6148

6149

Holds information about the target of a shortcut file.

6150

</summary>

6151

</member>

6152

6153

6154

Tests whether two shortcut targets have the same product code, feature, and/or component code.

6155

</summary>

6156

<param name="st1">The first shortcut target to compare.</param>

6157

<param name="st2">The second shortcut target to compare.</param>

6158

<returns>True if all parts of the targets are the same, else false.</returns>

6159

</member>

6160

6161

6162

Tests whether two shortcut targets have the same product code, feature, and/or component code.

6163

</summary>

6164

<param name="st1">The first shortcut target to compare.</param>

6165

<param name="st2">The second shortcut target to compare.</param>

6166

<returns>True if any parts of the targets are different, else false.</returns>

6167

</member>

6168

6169

6170

Tests whether two shortcut targets have the same product code, feature, and/or component code.

6171

</summary>

6172

<param name="obj">The shortcut target to compare to the current object.</param>

6173

<returns>True if <paramref name="obj"/> is a shortcut target and all parts of the targets are the same, else false.</returns>

6174

</member>

6175

6176

6177

Generates a hash code using all parts of the shortcut target.

6178

</summary>

6179

<returns>An integer suitable for hashing the shortcut target.</returns>

6180

</member>

6181

6182

6183

Gets the target product code of the shortcut, or null if not available.

6184

</summary>

6185

</member>

6186

6187

6188

Gets the name of the target feature of the shortcut, or null if not available.

6189

</summary>

6190

</member>

6191

6192

6193

Gets the target component code of the shortcut, or null if not available.

6194

</summary>

6195

</member>

6196

6197

6198

A list of sources for an installed product or patch.

6199

</summary>

6200

</member>

6201

6202

6203

Adds a network or URL source to the source list of the installed product.

6204

</summary>

6205

<param name="item">Path to the source to be added. This parameter is

6206

expected to contain only the path without the filename.</param>

6207

6208

If this method is called with a new source, the installer adds the source

6209

to the end of the source list.

6210

6211

If this method is called with a source already existing in the source

6212

list, it has no effect.

6213

6214

Win32 MSI APIs:

6215

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistaddsource.asp">MsiSourceListAddSource</a>,

6216

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistaddsourceex.asp">MsiSourceListAddSourceEx</a>

6217

</remarks>

6218

6219

</member>

6220

6221

6222

Adds or reorders a network or URL source for the product or patch.

6223

</summary>

6224

<param name="item">Path to the source to be added. This parameter is

6225

expected to contain only the path without the filename.</param>

6226

<param name="index">Specifies the priority order in which the source

6227

will be inserted</param>

6228

6229

If this method is called with a new source and <paramref name="index"/>

6230

is set to 0, the installer adds the source to the end of the source list.

6231

6232

If this method is called with a source already existing in the source

6233

list and <paramref name="index"/> is set to 0, the installer retains the

6234

source's existing index.

6235

6236

If the method is called with an existing source in the source list

6237

and <paramref name="index"/> is set to a non-zero value, the source is

6238

removed from its current location in the list and inserted at the position

6239

specified by Index, before any source that already exists at that position.

6240

6241

If the method is called with a new source and Index is set to a

6242

non-zero value, the source is inserted at the position specified by

6243

<paramref name="index"/>, before any source that already exists at

6244

that position. The index value for all sources in the list after the

6245

index specified by Index are updated to ensure unique index values and

6246

the pre-existing order is guaranteed to remain unchanged.

6247

6248

If <paramref name="index"/> is greater than the number of sources

6249

in the list, the source is placed at the end of the list with an index

6250

value one larger than any existing source.

6251

6252

Win32 MSI API:

6253

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistaddsourceex.asp">MsiSourceListAddSourceEx</a>

6254

</remarks>

6255

</member>

6256

6257

6258

Clears sources of all types: network, url, and media.

6259

</summary>

6260

6261

Win32 MSI API:

6262

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistclearall.asp">MsiSourceListClearAll</a>

6263

</remarks>

6264

</member>

6265

6266

6267

Removes all network sources from the list. URL sources are not affected.

6268

</summary>

6269

6270

Win32 MSI API:

6271

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistclearallex.asp">MsiSourceListClearAllEx</a>

6272

</remarks>

6273

</member>

6274

6275

6276

Removes all URL sources from the list. Network sources are not affected.

6277

</summary>

6278

6279

Win32 MSI API:

6280

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistclearallex.asp">MsiSourceListClearAllEx</a>

6281

</remarks>

6282

</member>

6283

6284

6285

Checks if the specified source exists in the list.

6286

</summary>

6287

<param name="item">case-insensitive source to look for</param>

6288

<returns>true if the source exists in the list, false otherwise</returns>

6289

</member>

6290

6291

6292

Copies the network and URL sources from this list into an array.

6293

</summary>

6294

<param name="array">destination array to be filed</param>

6295

<param name="arrayIndex">offset into the destination array where copying begins</param>

6296

</member>

6297

6298

6299

Removes a network or URL source.

6300

</summary>

6301

6302

Win32 MSI API:

6303

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistclearsource.asp">MsiSourceListClearSource</a>

6304

</remarks>

6305

</member>

6306

6307

6308

Enumerates the network and URL sources in the source list of the patch or product installation.

6309

</summary>

6310

6311

Win32 MSI API:

6312

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistenumsources.asp">MsiSourceListEnumSources</a>

6313

</remarks>

6314

</member>

6315

6316

6317

Forces the installer to search the source list for a valid

6318

source the next time a source is required. For example, when the

6319

installer performs an installation or reinstallation, or when it

6320

requires the path for a component that is set to run from source.

6321

</summary>

6322

6323

Win32 MSI APIs:

6324

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistforceresolution.asp">MsiSourceListForceResolution</a>,

6325

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistforceresolutionex.asp">MsiSourceListForceResolutionEx</a>

6326

</remarks>

6327

</member>

6328

6329

6330

Gets the list of disks registered for the media source of

6331

the patch or product installation.

6332

</summary>

6333

</member>

6334

6335

6336

Gets the number of network and URL sources in the list.

6337

</summary>

6338

</member>

6339

6340

6341

Gets a boolean value indicating whether the list is read-only.

6342

A SourceList is never read-only.

6343

</summary>

6344

<value>read-only status of the list</value>

6345

</member>

6346

6347

6348

Gets or sets the path relative to the root of the installation media.

6349

</summary>

6350

</member>

6351

6352

6353

Gets or sets the prompt template that is used when prompting the user

6354

for installation media.

6355

</summary>

6356

</member>

6357

6358

6359

Gets or sets the most recently used source location for the product.

6360

</summary>

6361

</member>

6362

6363

6364

Gets or sets the name of the Windows Installer package or patch package

6365

on the source.

6366

</summary>

6367

</member>

6368

6369

6370

Gets the type of the last-used source.

6371

</summary>

6372

6373

<ul>

6374

<li>"n" = network location</li>

6375

<li>"u" = URL location</li>

6376

<li>"m" = media location</li>

6377

<li>(empty string) = no last used source</li>

6378

</ul>

6379

</remarks>

6380

</member>

6381

6382

6383

Gets or sets source list information properties of a product or patch installation.

6384

</summary>

6385

<param name="property">The source list information property name.</param>

6386

<exception cref="T:System.ArgumentOutOfRangeException">An unknown product, patch, or property was requested</exception>

6387

6388

Win32 MSI API:

6389

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistgetinfo.asp">MsiSourceListGetInfo</a>

6390

</remarks>

6391

</member>

6392

6393

6394

A list of source media for an installed product or patch.

6395

</summary>

6396

</member>

6397

6398

6399

Adds or updates a disk of the media source for the product or patch.

6400

</summary>

6401

6402

To change the disk prompt only, get the existing volume label from the

6403

registry and provide it in this call along with the new disk prompt.

6404

Passing a null or empty string for <paramref name="volumeLabel"/>

6405

registers an empty string as the volume label.

6406

To change the volume label only, get the existing disk prompt

6407

that is registered and provide it when calling SourceListAddMediaDisk

6408

along with the new volume label. Passing null or an empty string

6409

registers an empty string as the disk prompt.

6410

6411

Win32 MSI API:

6412

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistaddmediadisk.asp">MsiSourceListAddMediaDisk</a>

6413

</remarks>

6414

</member>

6415

6416

6417

Removes all source media from the list.

6418

</summary>

6419

6420

Win32 MSI API:

6421

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistclearallex.asp">MsiSourceListClearAllEx</a>

6422

</remarks>

6423

</member>

6424

6425

6426

Checks if the specified media disk id exists in the list.

6427

</summary>

6428

<param name="diskId">disk id of the media to look for</param>

6429

<returns>true if the media exists in the list, false otherwise</returns>

6430

</member>

6431

6432

6433

Copies the source media info from this list into an array.

6434

</summary>

6435

<param name="array">destination array to be filed</param>

6436

<param name="arrayIndex">offset into the destination array where copying begins</param>

6437

</member>

6438

6439

6440

Removes a specified disk from the set of registered disks.

6441

</summary>

6442

<param name="diskId">ID of the disk to remove</param>

6443

6444

Win32 MSI API:

6445

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistclearmediadisk.asp">MsiSourceListClearMediaDisk</a>

6446

</remarks>

6447

</member>

6448

6449

6450

Enumerates the source media in the source list of the patch or product installation.

6451

</summary>

6452

6453

Win32 MSI API:

6454

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisourcelistenummediadisks.asp">MsiSourceListEnumMediaDisks</a>

6455

</remarks>

6456

</member>

6457

6458

6459

Gets the number of source media in the list.

6460

</summary>

6461

</member>

6462

6463

6464

Gets a boolean value indicating whether the list is read-only.

6465

A SourceMediaList is never read-only.

6466

</summary>

6467

<value>read-only status of the list</value>

6468

</member>

6469

6470

6471

Provides access to summary information of a Windows Installer database.

6472

</summary>

6473

</member>

6474

6475

6476

Gets a SummaryInfo object that can be used to examine, update, and add

6477

properties to the summary information stream of a package or transform.

6478

</summary>

6479

<param name="packagePath">Path to the package (database) or transform</param>

6480

<param name="enableWrite">True to reserve resources for writing summary information properties.</param>

6481

<exception cref="T:System.IO.FileNotFoundException">the package does not exist or could not be read</exception>

6482

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the package is an invalid format</exception>

6483

6484

The SummaryInfo object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

6485

It is best that the handle be closed manually as soon as it is no longer

6486

needed, as leaving lots of unused handles open can degrade performance.

6487

6488

Win32 MSI API:

6489

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msigetsummaryinformation.asp">MsiGetSummaryInformation</a>

6490

</remarks>

6491

</member>

6492

6493

6494

Formats and writes the previously stored properties into the standard summary information stream.

6495

</summary>

6496

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The stream cannot be successfully written.</exception>

6497

6498

This method may only be called once after all the property values have been set. Properties may

6499

still be read after the stream is written.

6500

6501

Win32 MSI API:

6502

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfopersist.asp">MsiSummaryInfoPersist</a>

6503

</remarks>

6504

</member>

6505

6506

<summary>Gets or sets the Title summary information property.</summary>

6507

6508

The Title summary information property briefly describes the type of installer package. Phrases

6509

such as "Installation Database" or "Transform" or "Patch" may be used for this property.

6510

6511

Win32 MSI APIs:

6512

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6513

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6514

</remarks>

6515

</member>

6516

6517

<summary>Gets or sets the Subject summary information property.</summary>

6518

6519

The Subject summary information property conveys to a file browser the product that can be installed using

6520

the logic and data in this installer database. For example, the value of the summary property for

6521

Microsoft Office 97 would be "Microsoft Office 97 Professional". This value is typically set from the

6522

installer property ProductName.

6523

6524

Win32 MSI APIs:

6525

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6526

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6527

</remarks>

6528

</member>

6529

6530

<summary>Gets or sets the Author summary information property.</summary>

6531

6532

The Author summary information property conveys to a file browser the manufacturer of the installation

6533

database. This value is typically set from the installer property Manufacturer.

6534

6535

Win32 MSI APIs:

6536

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6537

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6538

</remarks>

6539

</member>

6540

6541

<summary>Gets or sets the Keywords summary information property.</summary>

6542

6543

The Keywords summary information property is used by file browsers to hold keywords that permit the

6544

database file to be found in a keyword search. The set of keywords typically includes "Installer" as

6545

well as product-specific keywords, and may be localized.

6546

6547

Win32 MSI APIs:

6548

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6549

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6550

</remarks>

6551

</member>

6552

6553

<summary>Gets or sets the Comments summary information property.</summary>

6554

6555

The Comments summary information property conveys the general purpose of the installer database. By convention,

6556

the value for this summary property is set to the following:

6557

6558

"This installer database contains the logic and data required to install <product name>."

6559

6560

where <product name> is the name of the product being installed. In general the value for this summary

6561

property only changes in the product name, nothing else.

6562

6563

Win32 MSI APIs:

6564

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6565

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6566

</remarks>

6567

</member>

6568

6569

<summary>Gets or sets the Template summary information property.</summary>

6570

6571

The Template summary information propery indicates the platform and language versions supported by the database.

6572

6573

The syntax of the Template Summary property information is:

6574

[platform property][,platform property][,...];[language id][,language id][,...]

6575

6576

For example, the following are all valid values for the Template Summary property:

6577

6578

<item>Intel;1033</item>

6579

<item>Intel64;1033</item>

6580

6581

6582

<item>Intel ;1033,2046</item>

6583

<item>Intel64;1033,2046</item>

6584

<item>Intel;0</item>

6585

</list>

6586

6587

If this is a 64-bit Windows Installer, enter Intel64 in the Template summary information property. Note that an

6588

installation package cannot have both the Intel and Intel64 properties set.

6589

6590

If the current platform does not match one of the platforms specified then the installer will not process the

6591

package. Not specifying a platform implies that the package is platform-independent.

6592

6593

Entering 0 in the language ID field of the Template summary information property, or leaving this field empty,

6594

indicates that the package is language neutral.

6595

6596

There are variations of this property depending on whether it is in a source installer database or a transform.

6597

6598

Source Installer Database - Only one language can be specified in a source installer database. Merge Modules are

6599

the only packages that may have multiple languages. For more information, see Multiple Language Merge Modules.

6600

6601

Transform - In a transform file, only one language may be specified. The specified platform and language determine

6602

whether a transform can be applied to a particular database. The platform property and the language property can

6603

be left blank if no transform restriction relies on them to validate the transform.

6604

6605

This summary property is REQUIRED.

6606

6607

Win32 MSI APIs:

6608

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6609

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6610

</remarks>

6611

</member>

6612

6613

<summary>Gets or sets the LastSavedBy summary information property.</summary>

6614

6615

The installer sets the Last Saved By summary information property to the value of the LogonUser property during

6616

an administrative installation. The installer never uses this property and a user never needs to modify it.

6617

Developers of a database editing tool may use this property to track the last person to modify the database.

6618

This property should be left set to null in a final shipping database.

6619

6620

In a transform, this summary property contains the platform and language ID(s) that a database should have

6621

after it has been transformed. The property specifies to what the Template should be set in the new database.

6622

6623

Win32 MSI APIs:

6624

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6625

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6626

</remarks>

6627

</member>

6628

6629

<summary>Gets or sets the RevisionNumber summary information property.</summary>

6630

6631

The Revision Number summary information property contains the package code for the installer package. The

6632

package code is a unique identifier of the installer package.

6633

6634

The Revision Number summary information property of a patch package specifies the GUID patch code for

6635

the patch. This is followed by a list of patch code GUIDs for obsolete patches that are removed when this

6636

patch is applied. The patch codes are concatenated with no delimiters separating GUIDs in the list.

6637

6638

The Revision Number summary information property of a transform package lists the product code GUIDs

6639

and version of the new and original products and the upgrade code GUID. The list is separated with

6640

semicolons as follows.

6641

6642

Original-Product-Code Original-Product-Version ; New-Product Code New-Product-Version; Upgrade-Code

6643

6644

This summary property is REQUIRED.

6645

6646

Win32 MSI APIs:

6647

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6648

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6649

</remarks>

6650

</member>

6651

6652

<summary>Gets or sets the CreatingApp summary information property.</summary>

6653

6654

The CreatingApp summary information property conveys which application created the installer database.

6655

In general the value for this summary property is the name of the software used to author this database.

6656

6657

Win32 MSI APIs:

6658

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6659

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6660

</remarks>

6661

</member>

6662

6663

<summary>Gets or sets the LastPrintTime summary information property.</summary>

6664

6665

The LastPrintTime summary information property can be set to the date and time during an administrative

6666

installation to record when the administrative image was created. For non-administrative installations

6667

this property is the same as the CreateTime summary information property.

6668

6669

Win32 MSI APIs:

6670

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6671

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6672

</remarks>

6673

</member>

6674

6675

<summary>Gets or sets the CreateTime summary information property.</summary>

6676

6677

The CreateTime summary information property conveys when the installer database was created.

6678

6679

Win32 MSI APIs:

6680

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6681

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6682

</remarks>

6683

</member>

6684

6685

<summary>Gets or sets the LastSaveTime summary information property.</summary>

6686

6687

The LastSaveTime summary information property conveys when the last time the installer database was

6688

modified. Each time a user changes an installation the value for this summary property is updated to

6689

the current system time/date at the time the installer database was saved. Initially the value for

6690

this summary property is set to null to indicate that no changes have yet been made.

6691

6692

Win32 MSI APIs:

6693

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6694

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6695

</remarks>

6696

</member>

6697

6698

<summary>Gets or sets the CodePage summary information property.</summary>

6699

6700

The Codepage summary information property is the numeric value of the ANSI code page used for any

6701

strings that are stored in the summary information. Note that this is not the same code page for

6702

strings in the installation database. The Codepage summary information property is used to translate

6703

the strings in the summary information into Unicode when calling the Unicode API functions. The

6704

Codepage summary information property must be set before any string properties are set in the

6705

summary information.

6706

6707

Win32 MSI APIs:

6708

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6709

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6710

</remarks>

6711

</member>

6712

6713

<summary>Gets or sets the PageCount summary information property.</summary>

6714

6715

For an installation package, the PageCount summary information property contains the minimum

6716

installer version required. For Windows Installer version 1.0, this property must be set to the

6717

integer 100. For 64-bit Windows Installer Packages, this property must be set to the integer 200.

6718

6719

For a transform package, the PageCount summary information property contains minimum installer

6720

version required to process the transform. Set to the greater of the two PageCount summary information

6721

property values belonging to the databases used to generate the transform.

6722

6723

The PageCount summary information property is set to null in patch packages.

6724

6725

This summary property is REQUIRED.

6726

6727

Win32 MSI APIs:

6728

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6729

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6730

</remarks>

6731

</member>

6732

6733

<summary>Gets or sets the WordCount summary information property.</summary>

6734

6735

The WordCount summary information property indicates the type of source file image. If this property is

6736

not present, it defaults to 0. Note that this property is stored in place of the standard Count property.

6737

6738

This property is a bit field. New bits may be added in the future. At present the following bits are

6739

available:

6740

6741

<item>Bit 0: 0 = long file names, 1 = short file names</item>

6742

<item>Bit 1: 0 = source is uncompressed, 1 = source is compressed</item>

6743

<item>Bit 2: 0 = source is original media, 1 = source is administrative installation</item>

6744

<item>[MSI 4.0] Bit 3: 0 = elevated privileges can be required to install, 1 = elevated privileges are not required to install</item>

6745

</list>

6746

6747

These are combined to give the WordCount summary information property one of the following values

6748

indicating a type of source file image:

6749

6750

<item>0 - Original source using long file names. Matches tree in Directory table.</item>

6751

<item>1 - Original source using short file names. Matches tree in Directory table.</item>

6752

<item>2 - Compressed source files using long file names. Matches cabinets and files in the Media table.</item>

6753

<item>3 - Compressed source files using short file names. Matches cabinets and files in the Media table.</item>

6754

<item>4 - Administrative image using long file names. Matches tree in Directory table.</item>

6755

<item>5 - Administrative image using short file names. Matches tree in Directory table.</item>

6756

</list>

6757

6758

Note that if the package is marked as compressed (bit 1 is set), the installer only installs files

6759

located at the root of the source. In this case, even files marked as uncompressed in the File table must

6760

be located at the root to be installed. To specify a source image that has both a cabinet file (compressed

6761

files) and uncompressed files that match the tree in the Directory table, mark the package as uncompressed

6762

by leaving bit 1 unset (value=0) in the WordCount summary information property and set

6763

<see cref="F:Microsoft.Deployment.WindowsInstaller.FileAttributes.Compressed"/> (value=16384) in the Attributes column of the File table

6764

for each file in the cabinet.

6765

6766

For a patch package, the WordCount summary information property specifies the patch engine that was used

6767

to create the patch files. The default value is 1 and indicates that MSPATCH was used to create the patch

6768

A value of "2" means that the patch is using smaller, optimized, files available only with Windows Installer

6769

version 1.2 or later. A patch with a WordCount of "2" fails immediately if used with a Windows Installer

6770

version earlier than 1.2. A patch with a WordCount of "3" fails immediately if used with a Windows Installer

6771

version earlier than 2.0.

6772

6773

This summary property is REQUIRED.

6774

6775

Win32 MSI APIs:

6776

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6777

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6778

</remarks>

6779

</member>

6780

6781

<summary>Gets or sets the CharacterCount summary information property.</summary>

6782

6783

The CharacterCount summary information property is only used in transforms. This part of the summary

6784

information stream is divided into two 16-bit words. The upper word contains the transform validation

6785

flags. The lower word contains the transform error condition flags.

6786

6787

Win32 MSI APIs:

6788

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6789

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6790

</remarks>

6791

</member>

6792

6793

<summary>Gets or sets the Security summary information property.</summary>

6794

6795

The Security summary information property conveys whether the package should be opened as read-only. The database

6796

editing tool should not modify a read-only enforced database and should issue a warning at attempts to modify a

6797

read-only recommended database. The following values of this property are applicable to Windows Installer files:

6798

6799

<item>0 - no restriction</item>

6800

<item>2 - read only recommended</item>

6801

<item>4 - read only enforced</item>

6802

</list>

6803

6804

This property should be set to read-only recommended (2) for an installation database and to read-only

6805

enforced (4) for a transform or patch.

6806

6807

Win32 MSI APIs:

6808

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>,

6809

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

6810

</remarks>

6811

</member>

6812

6813

6814

Contains information about all the tables in a Windows Installer database.

6815

</summary>

6816

</member>

6817

6818

6819

Adds a new table to the database.

6820

</summary>

6821

<param name="item">information about the table to be added</param>

6822

<exception cref="T:System.InvalidOperationException">a table with the same name already exists in the database</exception>

6823

</member>

6824

6825

6826

Removes all tables (and all data) from the database.

6827

</summary>

6828

</member>

6829

6830

6831

Checks if the database contains a table with the given name.

6832

</summary>

6833

<param name="item">case-sensitive name of the table to search for</param>

6834

<returns>True if the table exists, false otherwise.</returns>

6835

</member>

6836

6837

6838

Copies the table information from this collection into an array.

6839

</summary>

6840

<param name="array">destination array to be filed</param>

6841

<param name="arrayIndex">offset into the destination array where copying begins</param>

6842

</member>

6843

6844

6845

Removes a table from the database.

6846

</summary>

6847

<param name="item">case-sensitive name of the table to be removed</param>

6848

<returns>true if the table was removed, false if the table did not exist</returns>

6849

</member>

6850

6851

6852

Enumerates the tables in the database.

6853

</summary>

6854

</member>

6855

6856

6857

Gets the number of tables in the database.

6858

</summary>

6859

</member>

6860

6861

6862

Gets a boolean value indicating whether the collection is read-only.

6863

A TableCollection is read-only when the database is read-only.

6864

</summary>

6865

<value>read-only status of the collection</value>

6866

</member>

6867

6868

6869

Gets information about a given table.

6870

</summary>

6871

<param name="table">case-sensitive name of the table</param>

6872

<returns>information about the requested table, or null if the table does not exist in the database</returns>

6873

</member>

6874

6875

6876

Defines a table in an installation database.

6877

</summary>

6878

</member>

6879

6880

6881

Creates a table definition.

6882

</summary>

6883

<param name="name">Name of the table.</param>

6884

<param name="columns">Columns in the table.</param>

6885

<param name="primaryKeys">The primary keys of the table.</param>

6886

</member>

6887

6888

6889

Gets a string representation of the table.

6890

</summary>

6891

<returns>The name of the table.</returns>

6892

</member>

6893

6894

6895

Gets the name of the table.

6896

</summary>

6897

</member>

6898

6899

6900

Gets information about the columns in this table.

6901

</summary>

6902

6903

This property queries the database every time it is called,

6904

to ensure the returned values are up-to-date. For best performance,

6905

hold onto the returned collection if using it more than once.

6906

</remarks>

6907

</member>

6908

6909

6910

Gets the names of the columns that are primary keys of the table.

6911

</summary>

6912

</member>

6913

6914

6915

Gets an SQL CREATE string that can be used to create the table.

6916

</summary>

6917

</member>

6918

6919

6920

Gets an SQL INSERT string that can be used insert a new record into the table.

6921

</summary>

6922

6923

The values are expressed as question-mark tokens, to be supplied by the record.

6924

</remarks>

6925

</member>

6926

6927

6928

Gets an SQL SELECT string that can be used to select all columns of the table.

6929

</summary>

6930

6931

The columns are listed explicitly in the SELECT string, as opposed to using "SELECT *".

6932

</remarks>

6933

</member>

6934

6935

6936

Contains specific information about an error encountered by the <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Validate(Microsoft.Deployment.WindowsInstaller.Record)"/>,

6937

<see cref="M:Microsoft.Deployment.WindowsInstaller.View.ValidateNew(Microsoft.Deployment.WindowsInstaller.Record)"/>, or <see cref="M:Microsoft.Deployment.WindowsInstaller.View.ValidateFields(Microsoft.Deployment.WindowsInstaller.Record)"/> methods of the

6938

<see cref="T:Microsoft.Deployment.WindowsInstaller.View"/> class.

6939

</summary>

6940

</member>

6941

6942

6943

Gets the type of validation error encountered.

6944

</summary>

6945

</member>

6946

6947

6948

Gets the column containing the error, or null if the error applies to the whole row.

6949

</summary>

6950

</member>

6951

6952

6953

A View represents a result set obtained when processing a query using the

6954

<see cref="M:Microsoft.Deployment.WindowsInstaller.Database.OpenView(System.String,System.Object[])"/> method of a

6955

<see cref="P:Microsoft.Deployment.WindowsInstaller.View.Database"/>. Before any data can be transferred,

6956

the query must be executed using the <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Execute(Microsoft.Deployment.WindowsInstaller.Record)"/> method, passing to

6957

it all replaceable parameters designated within the SQL query string.

6958

</summary>

6959

</member>

6960

6961

6962

Executes a SQL View query and supplies any required parameters. The query uses the

6963

question mark token to represent parameters as described in SQL Syntax. The values of

6964

these parameters are passed in as the corresponding fields of a parameter record.

6965

</summary>

6966

<param name="executeParams">Optional Record that supplies the parameters. This

6967

Record contains values to replace the parameter tokens in the SQL query.</param>

6968

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

6969

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

6970

6971

Win32 MSI API:

6972

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>

6973

</remarks>

6974

</member>

6975

6976

6977

Executes a SQL View query.

6978

</summary>

6979

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View could not be executed</exception>

6980

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

6981

6982

Win32 MSI API:

6983

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>

6984

</remarks>

6985

</member>

6986

6987

6988

Fetches the next sequential record from the view, or null if there are no more records.

6989

</summary>

6990

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View is not in an active state</exception>

6991

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

6992

6993

The Record object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

6994

It is best that the handle be closed manually as soon as it is no longer

6995

needed, as leaving lots of unused handles open can degrade performance.

6996

6997

Win32 MSI API:

6998

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

6999

</remarks>

7000

</member>

7001

7002

7003

Updates a fetched Record.

7004

</summary>

7005

<param name="mode">specifies the modify mode</param>

7006

<param name="record">the Record to modify</param>

7007

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the modification failed,

7008

or a validation was requested and the data did not pass</exception>

7009

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7010

7011

You can update or delete a record immediately after inserting, or seeking provided you

7012

have NOT modified the 0th field of the inserted or sought record.

7013

7014

To execute any SQL statement, a View must be created. However, a View that does not

7015

create a result set, such as CREATE TABLE, or INSERT INTO, cannot be used with any of

7016

the Modify methods to update tables though the view.

7017

7018

You cannot fetch a record containing binary data from one database and then use

7019

that record to insert the data into another database. To move binary data from one database

7020

to another, you should export the data to a file and then import it into the new database

7021

using a query and the <see cref="M:Microsoft.Deployment.WindowsInstaller.Record.SetStream(System.Int32,System.String)"/>. This ensures that each database has

7022

its own copy of the binary data.

7023

7024

Note that custom actions can only add, modify, or remove temporary rows, columns,

7025

or tables from a database. Custom actions cannot modify persistent data in a database,

7026

such as data that is a part of the database stored on disk.

7027

7028

Win32 MSI API:

7029

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7030

</remarks>

7031

7032

7033

7034

7035

7036

7037

7038

7039

7040

7041

7042

7043

7044

</member>

7045

7046

7047

Refreshes the data in a Record.

7048

</summary>

7049

<param name="record">the Record to be refreshed</param>

7050

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the refresh failed</exception>

7051

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7052

7053

The Record must have been obtained by calling <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/>. Fails with

7054

a deleted Record. Works only with read-write Records.

7055

7056

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7057

7058

Win32 MSI API:

7059

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7060

</remarks>

7061

</member>

7062

7063

7064

Inserts a Record into the view.

7065

</summary>

7066

<param name="record">the Record to be inserted</param>

7067

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the insertion failed</exception>

7068

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7069

7070

Fails if a row with the same primary keys exists. Fails with a read-only database.

7071

This method cannot be used with a View containing joins.

7072

7073

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7074

7075

Win32 MSI API:

7076

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7077

</remarks>

7078

</member>

7079

7080

7081

Updates the View with new data from the Record.

7082

</summary>

7083

7084

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the update failed</exception>

7085

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7086

7087

Only non-primary keys can be updated. The Record must have been obtained by calling

7088

<see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/>. Fails with a deleted Record. Works only with read-write Records.

7089

7090

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7091

7092

Win32 MSI API:

7093

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7094

</remarks>

7095

</member>

7096

7097

7098

Updates or inserts a Record into the View.

7099

</summary>

7100

<param name="record">the Record to be assigned</param>

7101

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the assignment failed</exception>

7102

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7103

7104

Updates record if the primary keys match an existing row and inserts if they do not match.

7105

Fails with a read-only database. This method cannot be used with a View containing joins.

7106

7107

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7108

7109

Win32 MSI API:

7110

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7111

</remarks>

7112

</member>

7113

7114

7115

Updates or deletes and inserts a Record into the View.

7116

</summary>

7117

<param name="record">the Record to be replaced</param>

7118

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the replacement failed</exception>

7119

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7120

7121

The Record must have been obtained by calling <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/>. Updates record if the

7122

primary keys are unchanged. Deletes old row and inserts new if primary keys have changed.

7123

Fails with a read-only database. This method cannot be used with a View containing joins.

7124

7125

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7126

7127

Win32 MSI API:

7128

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7129

</remarks>

7130

</member>

7131

7132

7133

Deletes a Record from the View.

7134

</summary>

7135

<param name="record">the Record to be deleted</param>

7136

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the deletion failed</exception>

7137

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7138

7139

The Record must have been obtained by calling <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/>. Fails if the row has been

7140

deleted. Works only with read-write records. This method cannot be used with a View containing joins.

7141

7142

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7143

7144

Win32 MSI API:

7145

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7146

</remarks>

7147

</member>

7148

7149

7150

Inserts a Record into the View. The inserted data is not persistent.

7151

</summary>

7152

<param name="record">the Record to be inserted</param>

7153

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the insertion failed</exception>

7154

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7155

7156

Fails if a row with the same primary key exists. Works only with read-write records.

7157

This method cannot be used with a View containing joins.

7158

7159

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7160

7161

Win32 MSI API:

7162

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7163

</remarks>

7164

</member>

7165

7166

7167

Refreshes the information in the supplied record without changing the position

7168

in the result set and without affecting subsequent fetch operations.

7169

</summary>

7170

<param name="record">the Record to be filled with the result of the seek</param>

7171

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the seek failed</exception>

7172

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7173

7174

After seeking, the Record may then be used for subsequent Update, Delete, and Refresh

7175

operations. All primary key columns of the table must be in the query and the Record must

7176

have at least as many fields as the query. Seek cannot be used with multi-table queries.

7177

This method cannot be used with a View containing joins.

7178

7179

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7180

7181

Win32 MSI API:

7182

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7183

</remarks>

7184

</member>

7185

7186

7187

Inserts or validates a record.

7188

</summary>

7189

<param name="record">the Record to be merged</param>

7190

<returns>true if the record was inserted or validated, false if there is an existing

7191

record with the same primary keys that is not identical</returns>

7192

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the merge failed (for a reason other than invalid data)</exception>

7193

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7194

7195

Works only with read-write records. This method cannot be used with a

7196

View containing joins.

7197

7198

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7199

7200

Win32 MSI API:

7201

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

7202

</remarks>

7203

</member>

7204

7205

7206

Validates a record, returning information about any errors.

7207

</summary>

7208

<param name="record">the Record to be validated</param>

7209

<returns>null if the record was validated; if there is an existing record with

7210

the same primary keys that has conflicting data then error information is returned</returns>

7211

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the validation failed (for a reason other than invalid data)</exception>

7212

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7213

7214

The Record must have been obtained by calling <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/>.

7215

Works with read-write and read-only records. This method cannot be used

7216

with a View containing joins.

7217

7218

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7219

7220

Win32 MSI APIs:

7221

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>,

7222

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewgeterror.asp">MsiViewGetError</a>

7223

</remarks>

7224

</member>

7225

7226

7227

Validates a new record, returning information about any errors.

7228

</summary>

7229

<param name="record">the Record to be validated</param>

7230

<returns>null if the record was validated; if there is an existing

7231

record with the same primary keys then error information is returned</returns>

7232

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the validation failed (for a reason other than invalid data)</exception>

7233

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7234

7235

Checks for duplicate keys. The Record must have been obtained by

7236

calling <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Fetch"/>. Works with read-write and read-only records.

7237

This method cannot be used with a View containing joins.

7238

7239

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7240

7241

Win32 MSI APIs:

7242

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>,

7243

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewgeterror.asp">MsiViewGetError</a>

7244

</remarks>

7245

</member>

7246

7247

7248

Validates fields of a fetched or new record, returning information about any errors.

7249

Can validate one or more fields of an incomplete record.

7250

</summary>

7251

<param name="record">the Record to be validated</param>

7252

<returns>null if the record was validated; if there is an existing record with

7253

the same primary keys that has conflicting data then error information is returned</returns>

7254

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the validation failed (for a reason other than invalid data)</exception>

7255

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7256

7257

Works with read-write and read-only records. This method cannot be used with

7258

a View containing joins.

7259

7260

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7261

7262

Win32 MSI APIs:

7263

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>,

7264

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewgeterror.asp">MsiViewGetError</a>

7265

</remarks>

7266

</member>

7267

7268

7269

Validates a record that will be deleted later, returning information about any errors.

7270

</summary>

7271

<param name="record">the Record to be validated</param>

7272

<returns>null if the record is safe to delete; if another row refers to

7273

the primary keys of this row then error information is returned</returns>

7274

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the validation failed (for a reason other than invalid data)</exception>

7275

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7276

7277

Validation does not check for the existence of the primary keys of this row in properties

7278

or strings. Does not check if a column is a foreign key to multiple tables. Works with

7279

read-write and read-only records. This method cannot be used with a View containing joins.

7280

7281

See <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Modify(Microsoft.Deployment.WindowsInstaller.ViewModifyMode,Microsoft.Deployment.WindowsInstaller.Record)"/> for more remarks.

7282

7283

Win32 MSI APIs:

7284

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>,

7285

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewgeterror.asp">MsiViewGetError</a>

7286

</remarks>

7287

</member>

7288

7289

7290

Enumerates over the Records retrieved by the View.

7291

</summary>

7292

<returns>An enumerator of Record objects.</returns>

7293

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">The View was not <see cref="M:Microsoft.Deployment.WindowsInstaller.View.Execute(Microsoft.Deployment.WindowsInstaller.Record)"/>d before attempting the enumeration.</exception>

7294

7295

Each Record object should be <see cref="M:Microsoft.Deployment.WindowsInstaller.InstallerHandle.Close"/>d after use.

7296

It is best that the handle be closed manually as soon as it is no longer

7297

needed, as leaving lots of unused handles open can degrade performance.

7298

However, note that it is not necessary to complete the enumeration just

7299

for the purpose of closing handles, because Records are fetched lazily

7300

on each step of the enumeration.

7301

7302

Win32 MSI API:

7303

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

7304

</remarks>

7305

</member>

7306

7307

7308

Gets the Database on which this View was opened.

7309

</summary>

7310

</member>

7311

7312

7313

Gets the SQL query string used to open this View.

7314

</summary>

7315

</member>

7316

7317

7318

Gets the set of tables that were included in the SQL query for this View.

7319

</summary>

7320

</member>

7321

7322

7323

Gets the set of columns that were included in the query for this View,

7324

or null if this view is not a SELECT query.

7325

</summary>

7326

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InstallerException">the View is not in an active state</exception>

7327

<exception cref="T:Microsoft.Deployment.WindowsInstaller.InvalidHandleException">the View handle is invalid</exception>

7328

7329

Win32 MSI API:

7330

<a href="http://msdn.microsoft.com/library/en-us/msi/setup/msiviewgetcolumninfo.asp">MsiViewGetColumnInfo</a>

7331

</remarks>

7332

</member>

7333

</members>

7334

</doc>