~jterrell/nunitv2/nunitv2

<see cref="T:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage"/> or <see cref="T:Microsoft.Deployment.WindowsInstaller.Package.PatchPackage"/>.

</summary>

<c>installPackage.Message += new InstallPackageMessageHandler(Console.WriteLine);</c>

</example>

</member>

Provides access to powerful build, maintenance, and analysis operations on an

installation package (.MSI or .MSM).

</summary>

</member>

Creates a new InstallPackage object. The file source directory and working

directory are the same as the location as the package file.

</summary>

<param name="packagePath">Path to the install package to be created or opened</param>

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

</member>

Creates a new InstallPackage object, specifying an alternate file source

directory and/or working directory.

</summary>

<param name="packagePath">Path to the install package to be created or opened</param>

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

<param name="sourceDir">Location to obtain source files and cabinets when extracting

or updating files in the working directory. This is often the location of an original

copy of the package that is not meant to be modified. If this parameter is null, it

defaults to the directory of <paramref name="packagePath"/>.</param>

<param name="workingDir">Location where files will be extracted to/updated from. Also

the location where a temporary folder is created during some operations. If this

parameter is null, it defaults to the directory of <paramref name="packagePath"/>.</param>

<remarks>If the source location is different than the working directory, then

no files will be modified at the source location.

</remarks>

</member>

Sends a message to the <see cref="E:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.Message"/> event-handler.

</summary>

<param name="format">Message string, containing 0 or more format items</param>

<param name="args">Items to be formatted</param>

</member>

Gets the list of file keys that have the specified long file name.

</summary>

<param name="longFileName">File name to search for (case-insensitive)</param>

<returns>Array of file keys, or a 0-length array if none are found</returns>

</member>

Gets the list of file keys whose long file names match a specified

regular-expression search pattern.

</summary>

<param name="pattern">Regular expression search pattern</param>

<returns>Array of file keys, or a 0-length array if none are found</returns>

</member>

Extracts all files to the <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.WorkingDirectory"/>. The files are extracted

to the relative directory matching their <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPath.SourcePath"/>.

</summary>

<remarks>If any files have the uncompressed attribute, they will be copied

from the <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.SourceDirectory"/>.</remarks>

</member>

Extracts a specified list of files to the <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.WorkingDirectory"/>. The files

are extracted to the relative directory matching their <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPath.SourcePath"/>.

</summary>

<param name="fileKeys">List of file key strings to extract</param>

<remarks>If any files have the uncompressed attribute, they will be copied

from the <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.SourceDirectory"/>.</remarks>

</member>

Updates the install package with new files from the <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.WorkingDirectory"/>. The

files must be in the relative directory matching their <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPath.SourcePath"/>.

This method re-compresses and packages the files if necessary, and also updates the

following data: File.FileSize, File.Version, File.Language, MsiFileHash.HashPart*

</summary>

The cabinet compression level used during re-cabbing can be configured with the

<see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.CompressionLevel"/> property.

</remarks>

</member>

100

101

Updates the install package with new files from the <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.WorkingDirectory"/>. The

102

files must be in the relative directory matching their <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPath.SourcePath"/>.

103

This method re-compresses and packages the files if necessary, and also updates the

104

following data: File.FileSize, File.Version, File.Language, MsiFileHash.HashPart?.

105

</summary>

106

<param name="fileKeys">List of file key strings to update</param>

107

108

This method does not change the media structure of the package, so it may require extracting

109

and re-compressing a large cabinet just to update one file.

110

The cabinet compression level used during re-cabbing can be configured with the

111

<see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.CompressionLevel"/> property.

112

</remarks>

113

</member>

114

115

116

Consolidates a package by combining and re-compressing all files into a single

117

internal or external cabinet.

118

</summary>

119

120

<remarks>If an installation package was built from many merge modules, this

121

method can somewhat decrease package size, complexity, and installation time.

122

This method will also convert a package with all or mostly uncompressed

123

files into a package where all files are compressed.

124

If the package contains any not-yet-applied binary file patches (for

125

example, a package generated by a call to <see cref="M:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.ApplyPatch(Microsoft.Deployment.WindowsInstaller.Package.PatchPackage,System.String)"/>) then

126

this method will apply the patches before compressing the updated files.

127

This method edits the database summary information and the File, Media

128

and Patch tables as necessary to maintain a valid installation package.

129

The cabinet compression level used during re-cabbing can be configured with the

130

<see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.CompressionLevel"/> property.

131

</remarks>

132

</member>

133

134

135

Rebuilds the cached directory structure information accessed by the

136

<see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.Directories"/> and <see cref="P:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.Files"/> properties. This

137

should be done after modifying the File, Component, or Directory

138

tables, or else the cached information may no longer be accurate.

139

</summary>

140

</member>

141

142

143

Applies a patch package to the database, resulting in an installation package that

144

has the patch built-in.

145

</summary>

146

<param name="patchPackage">The patch package to be applied</param>

147

<param name="transform">Optional name of the specific transform to apply.

148

This parameter is usually left null, which causes the patch to be searched for

149

a transform that is valid to apply to this database.</param>

150

151

If the patch contains any binary file patches, they will not immediately be applied

152

to the target files, though they will at installation time.

153

After calling this method you can use <see cref="M:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.Consolidate(System.String)"/> to apply

154

the file patches immediately and also discard any outdated files from the package.

155

</remarks>

156

</member>

157

158

159

Handle this event to receive status messages when operations are performed

160

on the install package.

161

</summary>

162

163

<c>installPackage.Message += new InstallPackageMessageHandler(Console.WriteLine);</c>

164

</example>

165

</member>

166

167

168

Gets or sets the location to obtain source files and cabinets when

169

extracting or updating files in the working directory. This is often

170

the location of an original copy of the package that is not meant

171

to be modified.

172

</summary>

173

</member>

174

175

176

Gets or sets the location where files will be extracted to/updated from. Also

177

the location where a temporary folder is created during some operations.

178

</summary>

179

</member>

180

181

182

Gets a mapping from Directory keys to source/target paths.

183

</summary>

184

185

If the Directory table is modified, this mapping

186

will be outdated until you call <see cref="M:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.UpdateDirectories"/>.

187

</remarks>

188

</member>

189

190

191

Gets a mapping from File keys to source/target paths.

192

</summary>

193

194

If the File, Component, or Directory tables are modified, this mapping

195

may be outdated until you call <see cref="M:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.UpdateDirectories"/>.

196

</remarks>

197

</member>

198

199

200

Gets or sets the compression level used by <see cref="M:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.UpdateFiles"/>

201

and <see cref="M:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage.Consolidate(System.String)"/>.

202

</summary>

203

204

If the Directory table is modified, this mapping will be outdated

205

until you close and reopen the install package.

206

</remarks>

207

</member>

208

209

210

Accessor for getting and setting properties of the InstallPackage database.

211

</summary>

212

</member>

213

214

215

Accessor for getting and setting properties of the <see cref="T:Microsoft.Deployment.WindowsInstaller.Package.InstallPackage"/> database.

216

</summary>

217

</member>

218

219

220

Gets or sets a property in the database. When getting a property

221

that does not exist in the database, an empty string is returned.

222

To remove a property from the database, set it to an empty string.

223

</summary>

224

225

This has the same results as direct SQL queries on the Property table; it's only

226

meant to be a more convenient way of access.

227

</remarks>

228

</member>

229

230

231

Represents the installation path of a file or directory from an installer product database.

232

</summary>

233

</member>

234

235

236

Creates a new InstallPath, specifying a filename.

237

</summary>

238

<param name="name">The name of the file or directory. Not a full path.</param>

239

</member>

240

241

242

Creates a new InstallPath, parsing out either the short or long filename.

243

</summary>

244

<param name="name">The name of the file or directory, in short|long syntax for a filename

245

or targetshort|targetlong:sourceshort|sourcelong syntax for a directory.</param>

246

<param name="useShortNames">true to parse the short part of the combined filename; false to parse the long part</param>

247

</member>

248

249

250

Gets the full source path.

251

</summary>

252

253

</member>

254

255

256

Gets the path of the parent directory.

257

</summary>

258

</member>

259

260

261

Gets the set of child paths if this InstallPath object represents a a directory.

262

</summary>

263

</member>

264

265

266

Gets or sets the source name of the InstallPath.

267

</summary>

268

</member>

269

270

271

Gets or sets the target name of the install path.

272

</summary>

273

</member>

274

275

276

Gets the full source path.

277

</summary>

278

</member>

279

280

281

Gets the full target path.

282

</summary>

283

</member>

284

285

286

Represents a collection of InstallPaths that are the child paths of the same parent directory.

287

</summary>

288

</member>

289

290

291

Adds a new child path to the collection.

292

</summary>

293

<param name="item">The InstallPath to add.</param>

294

</member>

295

296

297

Removes a child path to the collection.

298

</summary>

299

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

300

</member>

301

302

303

Gets the index of a child path in the collection.

304

</summary>

305

<param name="item">The InstallPath to search for.</param>

306

<returns>The index of the item, or -1 if not found.</returns>

307

</member>

308

309

310

Inserts a child path into the collection.

311

</summary>

312

<param name="index">The insertion index.</param>

313

<param name="item">The InstallPath to insert.</param>

314

</member>

315

316

317

Tests if the collection contains a child path.

318

</summary>

319

<param name="item">The InstallPath to search for.</param>

320

<returns>true if the item is found; false otherwise</returns>

321

</member>

322

323

324

Copies the collection into an array.

325

</summary>

326

<param name="array">The array to copy into.</param>

327

<param name="index">The starting index in the destination array.</param>

328

</member>

329

330

331

Removes an item from the collection.

332

</summary>

333

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

334

</member>

335

336

337

Removes all items from the collection.

338

</summary>

339

</member>

340

341

342

Gets an enumerator over all items in the collection.

343

</summary>

344

<returns>An enumerator for the collection.</returns>

345

</member>

346

347

348

Gets or sets the element at the specified index.

349

</summary>

350

</member>

351

352

353

Gets the number of items in the collection.

354

</summary>

355

</member>

356

357

358

Represents a mapping of install paths for all directories, components, or files in

359

an installation database.

360

</summary>

361

</member>

362

363

364

Builds a mapping from File keys to installation paths.

365

</summary>

366

<param name="db">Installation database.</param>

367

<param name="componentPathMap">Component mapping returned by <see cref="M:Microsoft.Deployment.WindowsInstaller.Package.InstallPathMap.BuildComponentPathMap(Microsoft.Deployment.WindowsInstaller.Database,Microsoft.Deployment.WindowsInstaller.Package.InstallPathMap)"/>.</param>

368

<param name="useShortNames">true to use short file names; false to use long names</param>

369

<returns>An InstallPathMap with the described mapping.</returns>

370

</member>

371

372

373

Builds a mapping from Component keys to installation paths.

374

</summary>

375

<param name="db">Installation database.</param>

376

<param name="directoryPathMap">Directory mapping returned by

377

378

<returns>An InstallPathMap with the described mapping.</returns>

379

</member>

380

381

382

Builds a mapping from Directory keys to installation paths.

383

</summary>

384

<param name="db">Installation database.</param>

385

<param name="useShortNames">true to use short directory names; false to use long names</param>

386

<returns>An InstallPathMap with the described mapping.</returns>

387

</member>

388

389

390

Builds a mapping of Directory keys to directory paths, specifying root directories

391

for the source and target paths.

392

</summary>

393

<param name="db">Database containing the Directory table.</param>

394

<param name="useShortNames">true to use short directory names; false to use long names</param>

395

<param name="sourceRootDir">The root directory path of all source paths, or null to leave them relative.</param>

396

<param name="targetRootDir">The root directory path of all source paths, or null to leave them relative.</param>

397

<returns>An InstallPathMap with the described mapping.</returns>

398

</member>

399

400

401

Creates a new empty InstallPathMap.

402

</summary>

403

</member>

404

405

406

Sets an install path for a direcotry, component, or file key.

407

</summary>

408

<param name="key">Depending on the type of InstallPathMap, this is the primary key from the

409

either the Directory, Component, or File table.</param>

410

<param name="installPath">The install path of the key item.</param>

411

412

Changing an install path does not modify the Database used to generate this InstallPathMap.

413

</remarks>

414

</member>

415

416

417

Removes an install path from the map.

418

</summary>

419

<param name="key">Depending on the type of InstallPathMap, this is the primary key from the

420

either the Directory, Component, or File table.</param>

421

<returns>true if the item was removed, false if it did not exist</returns>

422

423

Changing an install path does not modify the Database used to generate this InstallPathMap.

424

</remarks>

425

</member>

426

427

428

Tests whether a direcotry, component, or file key exists in the map.

429

</summary>

430

<param name="key">Depending on the type of InstallPathMap, this is the primary key from the

431

either the Directory, Component, or File table.</param>

432

<returns>true if the key is found; false otherwise</returns>

433

</member>

434

435

436

Attempts to get a value from the dictionary.

437

</summary>

438

<param name="key">The key to lookup.</param>

439

<param name="value">Receives the value, or null if they key was not found.</param>

440

<returns>True if the value was found, else false.</returns>

441

</member>

442

443

444

Removes all entries from the dictionary.

445

</summary>

446

</member>

447

448

449

Gets an enumerator over all entries in the dictionary.

450

</summary>

451

<returns>An enumerator for the dictionary.</returns>

452

</member>

453

454

455

Gets a mapping from keys to source paths.

456

</summary>

457

</member>

458

459

460

Gets a mapping from keys to target paths.

461

</summary>

462

</member>

463

464

465

Gets or sets an install path for a direcotry, component, or file key.

466

</summary>

467

<param name="key">Depending on the type of InstallPathMap, this is the primary key from the

468

either the Directory, Component, or File table.</param>

469

470

Changing an install path does not modify the Database used to generate this InstallPathMap.

471

</remarks>

472

</member>

473

474

475

Gets the collection of keys in the InstallPathMap. Depending on the type of InstallPathMap,

476

they are all directory, component, or file key strings.

477

</summary>

478

</member>

479

480

481

Gets the collection of InstallPath values in the InstallPathMap.

482

</summary>

483

</member>

484

485

486

Gets the number of entries in the dictionary.

487

</summary>

488

</member>

489

490

491

Provides access to convenient properties and operations on a patch package (.MSP).

492

</summary>

493

</member>

494

495

496

Creates a new patch package object; opening the patch database in read-only mode.

497

</summary>

498

<param name="packagePath">Path to the patch package (.MSP)</param>

499

<remarks>The PatchPackage object only opens the patch database in read-only mode, because

500

transforms (sub-storages) cannot be read if the database is open in read-write mode.</remarks>

501

</member>

502

503

504

Sends a message to the <see cref="E:Microsoft.Deployment.WindowsInstaller.Package.PatchPackage.Message"/> event-handler.

505

</summary>

506

<param name="format">Message string, containing 0 or more format items</param>

507

<param name="args">Items to be formatted</param>

508

</member>

509

510

511

Gets the list of patch codes that are replaced by this patch package.

512

</summary>

513

<returns>Array of replaced patch codes (GUIDs)</returns>

514

515

The list of replaced patch codes is stored in the RevisionNumber field of the patch summary information.

516

</remarks>

517

</member>

518

519

520

Gets the list of product codes of products targeted by this patch package.

521

</summary>

522

<returns>Array of product codes (GUIDs)</returns>

523

524

The list of target product codes is stored in the Template field of the patch summary information.

525

</remarks>

526

</member>

527

528

529

Gets the names of the transforms included in the patch package.

530

</summary>

531

<returns>Array of transform names</returns>

532

533

The returned list does not include the "patch special transforms" that are prefixed with "#"

534

The list of transform names is stored in the LastSavedBy field of the patch summary information.

535

</remarks>

536

</member>

537

538

539

Gets the names of the transforms included in the patch package.

540

</summary>

541

<param name="includeSpecialTransforms">Specifies whether to include the

542

"patch special transforms" that are prefixed with "#"</param>

543

<returns>Array of transform names</returns>

544

545

The list of transform names is stored in the LastSavedBy field of the patch summary information.

546

</remarks>

547

</member>

548

549

550

Gets information about the transforms included in the patch package.

551

</summary>

552

<returns>Array containing information about each transform</returns>

553

554

The returned info does not include the "patch special transforms" that are prefixed with "#"

555

</remarks>

556

</member>

557

558

559

Gets information about the transforms included in the patch package.

560

</summary>

561

<param name="includeSpecialTransforms">Specifies whether to include the

562

"patch special transforms" that are prefixed with "#"</param>

563

<returns>Array containing information about each transform</returns>

564

</member>

565

566

567

Gets information about a transforms included in the patch package.

568

</summary>

569

<param name="transform">Name of the transform to extract; this may optionally be a

570

special transform prefixed by "#"</param>

571

<returns>Information about the transform</returns>

572

</member>

573

574

575

Analyzes the transforms included in the patch package to find the ones that

576

are applicable to an install package.

577

</summary>

578

<param name="installPackage">The install package to validate the transforms against</param>

579

<returns>Array of valid transform names</returns>

580

581

The returned list does not include the "patch special transforms" that

582

are prefixed with "#" If a transform is valid, then its corresponding

583

special transform is assumed to be valid as well.

584

</remarks>

585

</member>

586

587

588

Extracts a transform (.MST) from a patch package.

589

</summary>

590

<param name="transform">Name of the transform to extract; this may optionally be a

591

special transform prefixed by "#"</param>

592

<param name="extractFile">Location where the transform will be extracted</param>

593

</member>

594

595

596

Handle this event to receive status messages when operations are performed on the patch package.

597

</summary>

598

599

<c>patchPackage.Message += new InstallPackageMessageHandler(Console.WriteLine);</c>

600

</example>

601

</member>

602

603

604

Gets the patch code (GUID) of the patch package.

605

</summary>

606

607

The patch code is stored in the RevisionNumber field of the patch summary information.

608

</remarks>

609

</member>

610

611

612

Contains properties of a transform package (.MST).

613

</summary>

614

</member>

615

616

617

Reads transform information from a transform package.

618

</summary>

619

<param name="mstFile">Path to a transform package (.MST file).</param>

620

</member>

621

622

623

Reads transform information from the summary information of a transform package.

624

</summary>

625

<param name="name">Filename of the transform (optional).</param>

626

<param name="transformSummaryInfo">Handle to the summary information of a transform package (.MST file).</param>

627

</member>

628

629

630

Returns the name of the transform.

631

</summary>

632

</member>

633

634

635

Gets the filename of the transform.

636

</summary>

637

</member>

638

639

640

Gets the target product code of the transform.

641

</summary>

642

</member>

643

644

645

Gets the target product version of the transform.

646

</summary>

647

</member>

648

649

650

Gets the upgrade product code of the transform.

651

</summary>

652

</member>

653

654

655

Gets the upgrade product version of the transform.

656

</summary>

657

</member>

658

659

660

Gets the upgrade code of the transform.

661

</summary>

662

</member>

663

664

665

Gets the target platform of the transform.

666

</summary>

667

</member>

668

669

670

Gets the target language of the transform, or 0 if the transform is language-neutral.

671

</summary>

672

</member>

673

674

675

Gets the validation flags specified when the transform was generated.

676

</summary>

677

</member>

678

</members>

679

</doc>

Older »