InstallException Class
The exception that is thrown when an error occurs during the commit, rollback, or uninstall phase of an installation.
System::Exception
System::SystemException
System.Configuration.Install::InstallException
Assembly: System.Configuration.Install (in System.Configuration.Install.dll)
The InstallException type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | InstallException() | Initializes a new instance of the InstallException class. |
![]() | InstallException(String) | Initializes a new instance of the InstallException class, and specifies the message to display to the user. |
![]() | InstallException(SerializationInfo, StreamingContext) | Infrastructure. Initializes a new instance of the InstallException class with serialized data. |
![]() | InstallException(String, Exception) | Initializes a new instance of the InstallException class, and specifies the message to display to the user, and a reference to the inner exception that is the cause of this exception. |
| Name | Description | |
|---|---|---|
![]() | Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
![]() | HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception.) |
![]() | HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.) |
![]() | InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
![]() | Message | Gets a message that describes the current exception. (Inherited from Exception.) |
![]() | Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.) |
![]() | StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.) |
![]() | TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetObjectData | When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.) |
![]() | GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Creates and returns a string representation of the current exception. (Inherited from Exception.) |
| Name | Description | |
|---|---|---|
![]() | SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.) |
The following example, plus the examples in the InstallException constructors, together make up an example showing an assembly having its own installer. The installer is named MyInstaller, which has an attribute RunInstallerAttribute, indicating that this installer will be invoked by Installutil.exe (Installer Tool). Installutil.exe (Installer Tool) calls the methods Commit, Rollback, Install and Uninstall. The code in Commit presumes that a file named FileDoesNotExist.txt exists before the installation of the assembly can be committed. If the file FileDoesNotExist.txt does not exist, Commit raises an InstallException. The same is the case with Uninstall in which an uninstallation will only happen if a file named FileDoesNotExist.txt exists. Otherwise it raises an InstallException. In Rollback, a code fragment is executed, which might raise an exception. If the exception is raised, it is caught and an InstallException is raised with that exception being passed to it.
Note |
|---|
Run this example with the help of Installutil.exe. Type this in the command prompt: |
Installutil InstallException.exe
-or-
Installutil /u InstallException.exe
#using <System.dll> #using <System.Configuration.Install.dll> using namespace System; using namespace System::ComponentModel; using namespace System::Collections; using namespace System::Configuration::Install; using namespace System::IO; [RunInstaller(true)] ref class MyInstaller: public Installer { public: virtual void Install( IDictionary^ savedState ) override { Installer::Install( savedState ); Console::WriteLine( "Install ..." ); // Commit is called when install goes through successfully. // Rollback is called if there is any error during Install. // Uncommenting the code below will lead to 'RollBack' being called, // currently 'Commit' shall be called. // throw new IOException(); } virtual void Commit( IDictionary^ savedState ) override { Installer::Commit( savedState ); Console::WriteLine( "Commit ..." ); // Throw an error if a particular file doesn't exist. if ( !File::Exists( "FileDoesNotExist.txt" ) ) throw gcnew InstallException; // Perform the final installation if the file exists. } virtual void Rollback( IDictionary^ savedState ) override { Installer::Rollback( savedState ); Console::WriteLine( "RollBack ..." ); try { // Performing some activity during rollback that raises an 'IOException*'. throw gcnew IOException; } catch ( Exception^ e ) { throw gcnew InstallException( "IOException* raised",e ); } // Perform the remaining rollback activites if no exception raised. } virtual void Uninstall( IDictionary^ savedState ) override { Installer::Uninstall( savedState ); Console::WriteLine( "UnInstall ..." ); // Throw an error if a particular file doesn't exist. if ( !File::Exists( "FileDoesNotExist.txt" ) ) throw gcnew InstallException( "The file 'FileDoesNotExist' does not exist" ); // Perform the uninstall activites if the file exists. } }; int main() { Console::WriteLine( "This assembly is just an example for the Installer" ); }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

