Deployment Tools Foundation
InstallPackage Class
Provides access to powerful build, maintenance, and analysis operations on an
installation package (.MSI or .MSM).
Declaration Syntax| C# | Visual Basic | Visual C++ | F# |
public class InstallPackage : Database
Public Class InstallPackage Inherits Database
public ref class InstallPackage : public Database
type InstallPackage = class inherit Database end
Members| All Members | Constructors | Methods | Properties | Events | |
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
InstallPackage(String, DatabaseOpenMode) |
Creates a new InstallPackage object. The file source directory and working
directory are the same as the location as the package file.
|
|
|
InstallPackage(String, DatabaseOpenMode, String, String) |
Creates a new InstallPackage object, specifying an alternate file source
directory and/or working directory.
|
|
|
ApplyPatch(PatchPackage, String) |
Applies a patch package to the database, resulting in an installation package that
has the patch built-in.
|
|
|
ApplyTransform(String) |
Apply a transform to the database, suppressing any error conditions
specified by the transform's summary information.
(Inherited from Database.) |
|
|
ApplyTransform(String, TransformErrors) |
Apply a transform to the database, specifying error conditions to suppress.
(Inherited from Database.) |
|
|
AsQueryable(Database) |
Converts any Database instance into a queryable database.
(Inherited from Queryable.) |
|
ClearReadOnlyAttribute(String, IEnumerable) |
Clears the +R flag on the specified files in the directory of your choice.
|
|
|
Close()()()() |
Closes the handle. After closing a handle, further method calls may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
CodePage |
Gets or sets the code page of the Database.
(Inherited from Database.) |
|
|
Commit()()()() |
Finalizes the persistent form of the database. All persistent data is written
to the writeable database, and no temporary columns or rows are written.
(Inherited from Database.) |
|
|
CompressionLevel |
Gets or sets the compression level used by UpdateFiles()()()()
and Consolidate(String).
|
|
|
Consolidate(String) |
Consolidates a package by combining and re-compressing all files into a single
internal or external cabinet.
|
|
|
CountRows(String) |
Gets the count of all rows in the table.
(Inherited from Database.) |
|
|
CountRows(String, String) |
Gets the count of all rows in the table that satisfy a given condition.
(Inherited from Database.) |
|
|
CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
|
|
CreateRecord(Int32) |
Creates a new record object with the requested number of fields.
(Inherited from Database.) |
|
|
CreateTransformSummaryInfo(Database, String, TransformErrors, TransformValidations) |
Creates and populates the summary information stream of an existing transform file, and
fills in the properties with the base and reference ProductCode and ProductVersion.
(Inherited from Database.) |
|
|
DeleteOnClose(String) |
Schedules a file or directory for deletion after the database handle is closed.
(Inherited from Database.) |
|
|
Directories |
Gets a mapping from Directory keys to source/target paths.
|
|
Dispose(Boolean) |
Closes the database handle. After closing a handle, further method calls may throw InvalidHandleException.
(Inherited from Database.) |
|
|
Dispose()()()() |
Closes the handle. After closing a handle, further method calls may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
|
Equals(Object) |
Tests whether this handle object is equal to another handle object. Two handle objects are equal
if their types are the same and their native integer handles are the same.
(Inherited from InstallerHandle.) |
|
|
Execute(String, array<Object>[]()[][]) |
Executes the query specified by a SQL string. The query may not be a SELECT statement.
(Inherited from Database.) |
|
|
Execute(String, Record) |
Executes the query specified by a SQL string. The query may not be a SELECT statement.
(Inherited from Database.) |
|
|
ExecuteIntegerQuery(String, array<Object>[]()[][]) |
Executes the specified SQL SELECT query and returns all results as integers.
(Inherited from Database.) |
|
|
ExecuteIntegerQuery(String, Record) |
Executes the specified SQL SELECT query and returns all results as integers.
(Inherited from Database.) |
|
|
ExecutePropertyQuery(String) |
Returns the value of the specified property.
(Inherited from Database.) |
|
|
ExecuteQuery(String, array<Object>[]()[][]) |
Executes the specified SQL SELECT query and returns all results.
(Inherited from Database.) |
|
|
ExecuteQuery(String, Record) |
Executes the specified SQL SELECT query and returns all results.
(Inherited from Database.) |
|
|
ExecuteScalar(String, array<Object>[]()[][]) |
Executes the specified SQL SELECT query and returns a single result.
(Inherited from Database.) |
|
|
ExecuteScalar(String, Record) |
Executes the specified SQL SELECT query and returns a single result.
(Inherited from Database.) |
|
|
ExecuteStringQuery(String, array<Object>[]()[][]) |
Executes the specified SQL SELECT query and returns all results as strings.
(Inherited from Database.) |
|
|
ExecuteStringQuery(String, Record) |
Executes the specified SQL SELECT query and returns all results as strings.
(Inherited from Database.) |
|
|
Export(String, String) |
Copies the structure and data from a specified table to a text archive file.
(Inherited from Database.) |
|
|
ExportAll(String) |
Exports all database tables, streams, and summary information to archive files.
(Inherited from Database.) |
|
|
ExtractFiles()()()() |
Extracts all files to the WorkingDirectory. The files are extracted
to the relative directory matching their SourcePath.
|
|
|
ExtractFiles(ICollection<(Of <<'(String>)>>)) |
Extracts a specified list of files to the WorkingDirectory. The files
are extracted to the relative directory matching their SourcePath.
|
|
|
FilePath |
Gets the file path the Database was originally opened from, or null if not known.
(Inherited from Database.) |
|
|
Files |
Gets a mapping from File keys to source/target paths.
|
|
|
Finalize()()()() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
FindFiles(String) |
Gets the list of file keys that have the specified long file name.
|
|
|
FindFiles(Regex) |
Gets the list of file keys whose long file names match a specified
regular-expression search pattern.
|
|
|
GenerateTransform(Database, String) |
Creates a transform that, when applied to the object database, results in the reference database.
(Inherited from Database.) |
|
|
GetFilePaths(String, ICollection<(Of <<'(String>)>>)) |
Provides a key (filename) / value (full path) pair where the Binary files can be worked with
|
|
|
GetHashCode()()()() |
Gets a hash value for the handle object.
(Inherited from InstallerHandle.) |
|
|
GetLifetimeService()()()() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
|
|
Handle |
Gets the native integer handle.
(Inherited from InstallerHandle.) |
|
|
Import(String) |
Imports a database table from a text archive file, dropping any existing table.
(Inherited from Database.) |
|
|
ImportAll(String) |
Imports all database tables, streams, and summary information from archive files.
(Inherited from Database.) |
|
|
InitializeLifetimeService()()()() | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
IsClosed |
Checks if the handle is closed. When closed, method calls on the handle object may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
|
IsColumnPersistent(String, String) |
Checks whether a table contains a persistent column with a given name.
(Inherited from Database.) |
|
|
IsReadOnly |
Gets a boolean value indicating whether this database was opened in read-only mode.
(Inherited from Database.) |
|
|
IsTablePersistent(String) |
Checks whether a table exists and is persistent in the database.
(Inherited from Database.) |
|
|
IsTransformValid(String) |
Checks whether a transform is valid for this Database, according to its validation data and flags.
(Inherited from Database.) |
|
|
IsTransformValid(SummaryInfo) |
Checks whether a transform is valid for this Database, according to its SummaryInfo data.
(Inherited from Database.) |
|
|
LogMessage(String, array<Object>[]()[][]) |
Sends a message to the Message event-handler.
|
|
|
MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
|
|
MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
Merge(Database, String) |
Merges another database with this database.
(Inherited from Database.) |
|
|
Merge(Database) |
Merges another database with this database.
(Inherited from Database.) |
|
Message |
Handle this event to receive status messages when operations are performed
on the install package.
|
|
|
OpenMode |
Gets the open mode for the database.
(Inherited from Database.) |
|
|
OpenView(String, array<Object>[]()[][]) |
Gets a View object representing the query specified by a SQL string.
(Inherited from Database.) |
|
|
Property |
Accessor for getting and setting properties of the InstallPackage database.
|
|
|
SourceDirectory |
Gets or sets the 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.
|
|
|
SummaryInfo |
Gets the SummaryInfo object for this database that can be used to examine and modify properties
to the summary information stream.
(Inherited from Database.) |
|
|
Tables |
Gets the collection of tables in the Database.
(Inherited from Database.) |
|
|
ToString()()()() |
Returns the file path of this database, or the handle value if a file path was not specified.
(Inherited from Database.) |
|
|
UpdateDirectories()()()() |
Rebuilds the cached directory structure information accessed by the
Directories and Files properties. This
should be done after modifying the File, Component, or Directory
tables, or else the cached information may no longer be accurate.
|
|
|
UpdateFiles()()()() |
Updates the install package with new files from the WorkingDirectory. The
files must be in the relative directory matching their 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*
|
|
|
UpdateFiles(ICollection<(Of <<'(String>)>>)) |
Updates the install package with new files from the WorkingDirectory. The
files must be in the relative directory matching their 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?.
|
|
|
ViewTransform(String) |
Apply a transform to the database, recording the changes in the "_TransformView" table.
(Inherited from Database.) |
|
|
WorkingDirectory |
Gets or sets the location where files will be extracted to/updated from. Also
the location where a temporary folder is created during some operations.
|
Inheritance Hierarchy| Object | ||||
|
MarshalByRefObject | |||
|
|
InstallerHandle | |||
|
|
Database | |||
|
|
InstallPackage | |||
Assembly: Microsoft.Deployment.WindowsInstaller.Package (Module: Microsoft.Deployment.WindowsInstaller.Package.dll) Version: 3.0.0.0 (3.11.1.2318)