mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

339
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/AssemblyInstaller.xml Normal file
View File

@@ -0,0 +1,339 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="AssemblyInstaller" FullName="System.Configuration.Install.AssemblyInstaller">
<TypeSignature Language="C#" Value="public class AssemblyInstaller : System.Configuration.Install.Installer" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.Install.Installer</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads an assembly, and runs all the installers in it.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AssemblyInstaller ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.AssemblyInstaller" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AssemblyInstaller (System.Reflection.Assembly assembly, string[] commandLine);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
<Parameter Name="commandLine" Type="System.String[]" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.AssemblyInstaller" /> class, and specifies both the assembly to install and the command line to use when creating a new <see cref="T:System.Configuration.Install.InstallContext" /> object.</para>
</summary>
<param name="assembly">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Reflection.Assembly" /> to install. </param>
<param name="commandLine">
<attribution license="cc4" from="Microsoft" modified="false" />The command line to use when creating a new <see cref="T:System.Configuration.Install.InstallContext" /> object for the assembly's installation. Can be a null value.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AssemblyInstaller (string fileName, string[] commandLine);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="fileName" Type="System.String" />
<Parameter Name="commandLine" Type="System.String[]" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.AssemblyInstaller" /> class, and specifies both the file name of the assembly to install and the command line to use when creating a new <see cref="T:System.Configuration.Install.InstallContext" /> object for the assembly's installation.</para>
</summary>
<param name="fileName">
<attribution license="cc4" from="Microsoft" modified="false" />The file name of the assembly to install. </param>
<param name="commandLine">
<attribution license="cc4" from="Microsoft" modified="false" />The command line to use when creating a new <see cref="T:System.Configuration.Install.InstallContext" /> object for the assembly's installation. Can be a null value.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Assembly">
<MemberSignature Language="C#" Value="public System.Reflection.Assembly Assembly { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Reflection.Assembly</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the assembly to install.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CheckIfInstallable">
<MemberSignature Language="C#" Value="public static void CheckIfInstallable (string assemblyName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assemblyName" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Configuration.Install.AssemblyInstaller.CheckIfInstallable(System.String)" /> method determines whether the specified assembly can be installed. To avoid an exception being thrown, the file must meet the following criteria: </para>
<list type="bullet">
<item>
<para>The file exists.</para>
</item>
<item>
<para>The file is a .NET Framework assembly.</para>
</item>
<item>
<para>The public types can be read from the file.</para>
</item>
<item>
<para>There is at least one public, non abstract class that extends the <see cref="T:System.Configuration.Install.Installer" /> class and contains the <see cref="F:System.ComponentModel.RunInstallerAttribute.Yes" /> attribute.</para>
</item>
<item>
<para>An instance of each installer can be created.</para>
</item>
</list>
<block subset="none" type="note">
<para>If the assembly is valid but contains no installers, an exception is thrown. This behavior differs from that at install time, when it is not an error to install an empty assembly.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Checks to see if the specified assembly can be installed.</para>
</summary>
<param name="assemblyName">
<attribution license="cc4" from="Microsoft" modified="false" />The assembly in which to search for installers. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CommandLine">
<MemberSignature Language="C#" Value="public string[] CommandLine { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the command line to use when creating a new <see cref="T:System.Configuration.Install.InstallContext" /> object for the assembly's installation.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Commit">
<MemberSignature Language="C#" Value="public override void Commit (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is called only if the <see cref="M:System.Configuration.Install.AssemblyInstaller.Install(System.Collections.IDictionary)" /> methods of all the installers in this instance's <see cref="T:System.Configuration.Install.InstallerCollection" /> succeed. This method then calls the <see cref="M:System.Configuration.Install.AssemblyInstaller.Commit(System.Collections.IDictionary)" /> method of each installer in the collection.</para>
<para>Store any information that you might need to do a correct uninstall operation in the saved-state <see cref="T:System.Collections.IDictionary" />, which is passed to the <see cref="M:System.Configuration.Install.AssemblyInstaller.Uninstall(System.Collections.IDictionary)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Completes the installation transaction.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the state of the computer after all the installers in the installer collection have run. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HelpText">
<MemberSignature Language="C#" Value="public override string HelpText { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An example of an installation program is the InstallUtil.exe utility.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the help text for all the installers in the installer collection.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Install">
<MemberSignature Language="C#" Value="public override void Install (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method calls the <see cref="M:System.Configuration.Install.AssemblyInstaller.Install(System.Collections.IDictionary)" /> method of each installer contained in the <see cref="P:System.Configuration.Install.Installer.Installers" /> property of this instance. The <see cref="T:System.Collections.IDictionary" /> object specified by the <paramref name="savedState" /> parameter is updated to reflect the status of the installation after the contained installers have run. If all the <see cref="M:System.Configuration.Install.AssemblyInstaller.Install(System.Collections.IDictionary)" /> methods succeed, the <see cref="M:System.Configuration.Install.AssemblyInstaller.Commit(System.Collections.IDictionary)" /> method is called. Otherwise, the <see cref="M:System.Configuration.Install.AssemblyInstaller.Rollback(System.Collections.IDictionary)" /> method is called.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Performs the installation.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> used to save information needed to perform a commit, rollback, or uninstall operation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the path of the assembly to install.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Rollback">
<MemberSignature Language="C#" Value="public override void Rollback (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A rollback restores the computer to the state it was in before the installation occurred. The <see cref="M:System.Configuration.Install.AssemblyInstaller.Rollback(System.Collections.IDictionary)" /> method is called if the <see cref="M:System.Configuration.Install.AssemblyInstaller.Install(System.Collections.IDictionary)" /> method of this <see cref="T:System.Configuration.Install.Installer" /> instance or of any installer in the installer collection fails to run correctly. Any exceptions generated by calling the <see cref="M:System.Configuration.Install.AssemblyInstaller.Rollback(System.Collections.IDictionary)" /> method of an installer in the collection are ignored, and the rollback of the other installers continues.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Restores the computer to the state it was in before the installation.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the pre-installation state of the computer. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Uninstall">
<MemberSignature Language="C#" Value="public override void Uninstall (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call this method to remove a previously completed installation. If the <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> method fails for one of the installers in the collection, it is still called for the remaining installers. A failed uninstallation does not roll back the computer to its pre-uninstallation state.</para>
<block subset="none" type="note">
<para>Although the <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" /> and <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" /> methods save the state of the computer after the installations, the file containing the <see cref="T:System.Collections.IDictionary" /> from the <paramref name="savedState" /> parameter might have been deleted at some point after the installation was complete. If the file is deleted, the <paramref name="savedState" /> parameter is null.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes an installation.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the post-installation state of the computer. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UseNewContext">
<MemberSignature Language="C#" Value="public bool UseNewContext { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Setting this property to true creates a new file named "{Assembly name}.InstallLog" to log messages for this assembly. Setting <see cref="P:System.Configuration.Install.AssemblyInstaller.UseNewContext" /> to false prevents the new file from being created.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether to create a new <see cref="T:System.Configuration.Install.InstallContext" /> object for the assembly's installation.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

94
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ComponentInstaller.xml Normal file
View File

@@ -0,0 +1,94 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ComponentInstaller" FullName="System.Configuration.Install.ComponentInstaller">
<TypeSignature Language="C#" Value="public abstract class ComponentInstaller : System.Configuration.Install.Installer" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.Install.Installer</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies an installer that copies properties from a component to use at install time.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ComponentInstaller ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.ComponentInstaller" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CopyFromComponent">
<MemberSignature Language="C#" Value="public abstract void CopyFromComponent (System.ComponentModel.IComponent component);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The installer should take all the information it can from the live component, and store it for use at install time.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, copies all the properties that are required at install time from the specified component.</para>
</summary>
<param name="component">
<attribution license="cc4" from="Microsoft" modified="false" />The component to copy from. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsEquivalentInstaller">
<MemberSignature Language="C#" Value="public virtual bool IsEquivalentInstaller (System.Configuration.Install.ComponentInstaller otherInstaller);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="otherInstaller" Type="System.Configuration.Install.ComponentInstaller" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Typically, <see cref="M:System.Configuration.Install.ComponentInstaller.IsEquivalentInstaller(System.Configuration.Install.ComponentInstaller)" /> returns true only if this installer and the installer specified by the <paramref name="otherInstaller" /> parameter install the same object. In such a case, calling the <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" /> or <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> method on either installer results in the same system state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines if the specified installer installs the same object as this installer.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if this installer and the installer specified by the <paramref name="otherInstaller" /> parameter install the same object; otherwise, false.</para>
</returns>
<param name="otherInstaller">
<attribution license="cc4" from="Microsoft" modified="false" />The installer to compare. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

57
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/IManagedInstaller.xml Normal file
View File

@@ -0,0 +1,57 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IManagedInstaller" FullName="System.Configuration.Install.IManagedInstaller">
<TypeSignature Language="C#" Value="public interface IManagedInstaller" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("1E233FE7-C16D-4512-8C3B-2E9988F08D38")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides an interface for a managed installer.</para>
</summary>
</Docs>
<Members>
<Member MemberName="ManagedInstall">
<MemberSignature Language="C#" Value="public int ManagedInstall (string commandLine, int hInstall);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="commandLine" Type="System.String" />
<Parameter Name="hInstall" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Executes a managed installation.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The return code for installutil.exe. A successful installation returns 0. Other values indicate failure.</para>
</returns>
<param name="commandLine">
<attribution license="cc4" from="Microsoft" modified="false" />The command line that specifies the installation.</param>
<param name="hInstall">
<attribution license="cc4" from="Microsoft" modified="false" />The handle to the installation.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

178
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallContext.xml Normal file
View File

@@ -0,0 +1,178 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="InstallContext" FullName="System.Configuration.Install.InstallContext">
<TypeSignature Language="C#" Value="public class InstallContext" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Typically, an <see cref="T:System.Configuration.Install.InstallContext" /> is created by an installation executable, such as InstallUtil.exe, that installs assemblies. The installation program invokes the <see cref="T:System.Configuration.Install.InstallContext" /> constructor, passing it the default log-file path and command-line parameters.</para>
<para>Prior to calling its <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Rollback(System.Collections.IDictionary)" />, or <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> methods, the installation program sets the <see cref="P:System.Configuration.Install.Installer.Context" /> property of an <see cref="T:System.Configuration.Install.Installer" /> to the instance of <see cref="T:System.Configuration.Install.InstallContext" />. Before calling these methods, an <see cref="T:System.Configuration.Install.Installer" /> that contains an installer collection in the <see cref="P:System.Configuration.Install.Installer.Installers" /> property sets the <see cref="P:System.Configuration.Install.Installer.Context" /> property of each contained installer.</para>
<para>The <see cref="P:System.Configuration.Install.InstallContext.Parameters" /> property contains a parsed version of the command line that is entered to run the installation executable. The property contains information such as the path to a log file, whether to display log information on the console, and whether to show a user interface during the installation. Call the <see cref="M:System.Configuration.Install.InstallContext.IsParameterTrue(System.String)" /> method to find out whether a command-line parameter is true.</para>
<para>Use the <see cref="M:System.Configuration.Install.InstallContext.LogMessage(System.String)" /> method to write status messages to the installation log file and the console.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Contains information about the current installation.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstallContext ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This overload does not create a log file for the installation.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.InstallContext" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstallContext (string logFilePath, string[] commandLine);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="logFilePath" Type="System.String" />
<Parameter Name="commandLine" Type="System.String[]" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the installation uses <format type="text/html"><a href="3F9D0533-F895-4897-B4EA-528284E0241D">[&lt;topic://cpconInstallerUtilityInstallutilexe&gt;]</a></format>, this constructor creates a log file at the specified path and parses the array of command-line parameters into the <see cref="P:System.Configuration.Install.InstallContext.Parameters" /> property. If a log-file path is specified in the command-line parameters, it is used to create the file. If the log file argument is not specified in the command line, the value of the <paramref name="logFilePath" /> parameter is used. To suppress the creation of a log file, pass the "/logfile= " command-line parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.InstallContext" /> class, and creates a log file for the installation.</para>
</summary>
<param name="logFilePath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the log file for this installation, or null if no log file should be created. </param>
<param name="commandLine">
<attribution license="cc4" from="Microsoft" modified="false" />The command-line parameters entered when running the installation program, or null if none were entered. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsParameterTrue">
<MemberSignature Language="C#" Value="public bool IsParameterTrue (string paramName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="paramName" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method accesses the <see cref="P:System.Configuration.Install.InstallContext.Parameters" /> property, which contains a parsed version of the command-line parameters, to determine whether the specified parameter is true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the specified command-line parameter is true.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the specified parameter is set to "yes", "true", "1", or an empty string (""); otherwise, false.</para>
</returns>
<param name="paramName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the command-line parameter to check. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="LogMessage">
<MemberSignature Language="C#" Value="public void LogMessage (string message);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An installer can call this method to write progress or other status information to the log file. If the command-line parameters specify that a user interface should be displayed, the installer should show message boxes or make queries in addition to calling the <see cref="M:System.Configuration.Install.InstallContext.LogMessage(System.String)" /> method. Text written to the log file will not be seen by the user unless InstallUtil.exe is used to run the installation and "/LogToConsole= true" is specified in the command line.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes a message to the console and to the log file for the installation.</para>
</summary>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The message to write. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public System.Collections.Specialized.StringDictionary Parameters { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Specialized.StringDictionary</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a new <see cref="T:System.Configuration.Install.InstallContext" /> is created, the command-line parameters are parsed into the <see cref="P:System.Configuration.Install.InstallContext.Parameters" /> property. Both the keys and the values of the parameters are strings.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the command-line parameters that were entered when InstallUtil.exe was run.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ParseCommandLine">
<MemberSignature Language="C#" Value="protected static System.Collections.Specialized.StringDictionary ParseCommandLine (string[] args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Specialized.StringDictionary</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="args" Type="System.String[]" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Parses the command-line parameters into a string dictionary.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Collections.Specialized.StringDictionary" /> containing the parsed command-line parameters.</para>
</returns>
<param name="args">
<attribution license="cc4" from="Microsoft" modified="false" />An array containing the command-line parameters. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

81
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallEventArgs.xml Normal file
View File

@@ -0,0 +1,81 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="InstallEventArgs" FullName="System.Configuration.Install.InstallEventArgs">
<TypeSignature Language="C#" Value="public class InstallEventArgs : EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Configuration.Install.InstallEventArgs" /> contains an <see cref="T:System.Collections.IDictionary" /> that holds information about the current state of the installation. The <see cref="E:System.Configuration.Install.Installer.BeforeInstall" />, <see cref="E:System.Configuration.Install.Installer.AfterInstall" />, <see cref="E:System.Configuration.Install.Installer.Committing" />, <see cref="E:System.Configuration.Install.Installer.Committed" />, <see cref="E:System.Configuration.Install.Installer.BeforeRollback" />, <see cref="E:System.Configuration.Install.Installer.AfterRollback" />, <see cref="E:System.Configuration.Install.Installer.BeforeUninstall" />, and <see cref="E:System.Configuration.Install.Installer.AfterUninstall" /> event handlers use this information.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides data for the events: <see cref="E:System.Configuration.Install.Installer.BeforeInstall" />, <see cref="E:System.Configuration.Install.Installer.AfterInstall" />, <see cref="E:System.Configuration.Install.Installer.Committing" />, <see cref="E:System.Configuration.Install.Installer.Committed" />, <see cref="E:System.Configuration.Install.Installer.BeforeRollback" />, <see cref="E:System.Configuration.Install.Installer.AfterRollback" />, <see cref="E:System.Configuration.Install.Installer.BeforeUninstall" />, <see cref="E:System.Configuration.Install.Installer.AfterUninstall" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstallEventArgs ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.InstallEventArgs" /> class, and leaves the <see cref="P:System.Configuration.Install.InstallEventArgs.SavedState" /> property empty.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstallEventArgs (System.Collections.IDictionary savedState);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.InstallEventArgs" /> class, and specifies the value for the <see cref="P:System.Configuration.Install.InstallEventArgs.SavedState" /> property.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that represents the current state of the installation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SavedState">
<MemberSignature Language="C#" Value="public System.Collections.IDictionary SavedState { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IDictionary</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets an <see cref="T:System.Collections.IDictionary" /> that represents the current state of the installation.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

31
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallEventHandler.xml Normal file
View File

@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="InstallEventHandler" FullName="System.Configuration.Install.InstallEventHandler">
<TypeSignature Language="C#" Value="public delegate void InstallEventHandler(object sender, InstallEventArgs e);" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.Configuration.Install.InstallEventArgs" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="sender">To be added.</param>
<param name="e">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When you create an <see cref="T:System.Configuration.Install.InstallEventHandler" /> delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see <format type="text/html"><a href="D98FD58B-FA4F-4598-8378-ADDF4355A115">[&lt;topic://cpconEventsDelegates&gt;]</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the method that will handle the <see cref="E:System.Configuration.Install.Installer.BeforeInstall" />, <see cref="E:System.Configuration.Install.Installer.AfterInstall" />, <see cref="E:System.Configuration.Install.Installer.Committing" />, <see cref="E:System.Configuration.Install.Installer.Committed" />, <see cref="E:System.Configuration.Install.Installer.BeforeRollback" />, <see cref="E:System.Configuration.Install.Installer.AfterRollback" />, <see cref="E:System.Configuration.Install.Installer.BeforeUninstall" />, or <see cref="E:System.Configuration.Install.Installer.AfterUninstall" /> event of an <see cref="T:System.Configuration.Install.Installer" />.</para>
</summary>
</Docs>
</Type>

104
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallException.xml Normal file
View File

@@ -0,0 +1,104 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="InstallException" FullName="System.Configuration.Install.InstallException">
<TypeSignature Language="C#" Value="public class InstallException : SystemException" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.SystemException</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The exception that is thrown when an error occurs during the commit, rollback, or uninstall phase of an installation.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstallException ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.InstallException" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstallException (string message);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.InstallException" /> class, and specifies the message to display to the user.</para>
</summary>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The message to display to the user. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected InstallException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.InstallException" /> class with serialized data.</para>
</summary>
<param name="info">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown. </param>
<param name="context">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstallException (string message, Exception innerException);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="innerException" Type="System.Exception" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.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.</para>
</summary>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The message to display to the user. </param>
<param name="innerException">
<attribution license="cc4" from="Microsoft" modified="false" />The exception that is the cause of the current exception. If the <paramref name="innerException" /> parameter is not null, the current exception is raised in a catch block that handles the inner exception. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

626
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/Installer.xml Normal file
View File

File diff suppressed because it is too large Load Diff

355
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallerCollection.xml Normal file
View File

@@ -0,0 +1,355 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="InstallerCollection" FullName="System.Configuration.Install.InstallerCollection">
<TypeSignature Language="C#" Value="public class InstallerCollection : System.Collections.CollectionBase" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Collections.CollectionBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Configuration.Install.InstallerCollection" /> provides the methods and properties that your application needs to manage a collection of <see cref="T:System.Configuration.Install.Installer" /> objects.</para>
<para>Use any of the following three ways to add installers to the collection: </para>
<list type="bullet">
<item>
<para>The <see cref="M:System.Configuration.Install.InstallerCollection.Add(System.Configuration.Install.Installer)" /> method adds a single installer to the collection.</para>
</item>
<item>
<para>The <see cref="M:System.Configuration.Install.InstallerCollection.AddRange(System.Configuration.Install.InstallerCollection)" /> methods add multiple installers to the collection.</para>
</item>
<item>
<para>The <see cref="M:System.Configuration.Install.InstallerCollection.Insert(System.Int32,System.Configuration.Install.Installer)" /> method and the <see cref="P:System.Configuration.Install.InstallerCollection.Item(System.Int32)" /> property, which is the <see cref="T:System.Configuration.Install.InstallerCollection" /> indexer, each add a single installer to the collection at the specified index.</para>
</item>
</list>
<para>Remove installers through the <see cref="M:System.Configuration.Install.InstallerCollection.Remove(System.Configuration.Install.Installer)" /> method. Check whether an installer is in the collection by using the <see cref="M:System.Configuration.Install.InstallerCollection.Contains(System.Configuration.Install.Installer)" /> method. Find where an installer is located in the collection by using the <see cref="M:System.Configuration.Install.InstallerCollection.IndexOf(System.Configuration.Install.Installer)" /> method.</para>
<para>The installers in a collection are run when the installer containing the collection, as specified by the <see cref="P:System.Configuration.Install.Installer.Parent" /> property, calls their <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Rollback(System.Collections.IDictionary)" />, or <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> methods.</para>
<para>For examples of the usage of an installer collection, see the <see cref="T:System.Configuration.Install.AssemblyInstaller" /> and <see cref="T:System.Configuration.Install.TransactedInstaller" /> classes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Contains a collection of installers to be run during an installation.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public int Add (System.Configuration.Install.Installer value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Configuration.Install.Installer" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Configuration.Install.Installer.Parent" /> property of the added <see cref="T:System.Configuration.Install.Installer" /> is set to specify the <see cref="T:System.Configuration.Install.Installer" /> containing this collection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified installer to this collection of installers.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The zero-based index of the added installer.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Configuration.Install.Installer" /> that represents the installer to add to the collection. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AddRange">
<MemberSignature Language="C#" Value="public void AddRange (System.Configuration.Install.Installer[] value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Configuration.Install.Installer[]" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Configuration.Install.Installer.Parent" /> property of each added <see cref="T:System.Configuration.Install.Installer" /> is set to the <see cref="T:System.Configuration.Install.Installer" /> containing this collection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified array of installers to this collection.</para>
</summary>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />An array of type <see cref="T:System.Configuration.Install.Installer" /> that represents the installers to add to this collection. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AddRange">
<MemberSignature Language="C#" Value="public void AddRange (System.Configuration.Install.InstallerCollection value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Configuration.Install.InstallerCollection" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Configuration.Install.Installer.Parent" /> property of each added <see cref="T:System.Configuration.Install.Installer" /> is set to the <see cref="T:System.Configuration.Install.Installer" /> containing this collection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified collection of installers to this collection.</para>
</summary>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Configuration.Install.InstallerCollection" /> that represents the installers to add to this collection. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (System.Configuration.Install.Installer value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Configuration.Install.Installer" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the specified installer is included in collection.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the specified installer is in this collection; otherwise, false.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Configuration.Install.Installer" /> that represents the installer to look for. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CopyTo">
<MemberSignature Language="C#" Value="public void CopyTo (System.Configuration.Install.Installer[] array, int index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="array" Type="System.Configuration.Install.Installer[]" />
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies the items from the collection to an array, begining at the specified index.</para>
</summary>
<param name="array">
<attribution license="cc4" from="Microsoft" modified="false" />The array to copy to. </param>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The index of the array at which to paste the collection. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IndexOf">
<MemberSignature Language="C#" Value="public int IndexOf (System.Configuration.Install.Installer value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Configuration.Install.Installer" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines the index of a specified installer in the collection.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The zero-based index of the installer in the collection.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Configuration.Install.Installer" /> to locate in the collection. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Insert">
<MemberSignature Language="C#" Value="public void Insert (int index, System.Configuration.Install.Installer value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="value" Type="System.Configuration.Install.Installer" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Inserts the specified installer into the collection at the specified index.</para>
</summary>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which to insert the installer. </param>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Configuration.Install.Installer" /> to insert. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public System.Configuration.Install.Installer this[int index] { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Configuration.Install.Installer</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="OnInsert">
<MemberSignature Language="C#" Value="protected override void OnInsert (int index, object value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Performs additional custom processes before a new installer is inserted into the collection.</para>
</summary>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which to insert <paramref name="value" />.</param>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The new value of the installer at <paramref name="index" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="OnRemove">
<MemberSignature Language="C#" Value="protected override void OnRemove (int index, object value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Performs additional custom processes before an installer is removed from the collection.</para>
</summary>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which <paramref name="value" /> can be found.</param>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The installer to be removed from <paramref name="index" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="OnSet">
<MemberSignature Language="C#" Value="protected override void OnSet (int index, object oldValue, object newValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="oldValue" Type="System.Object" />
<Parameter Name="newValue" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Performs additional custom processes before an existing installer is set to a new value.</para>
</summary>
<param name="index">
<attribution license="cc4" from="Microsoft" modified="false" />The zero-based index at which to replace <paramref name="oldValue" />.</param>
<param name="oldValue">
<attribution license="cc4" from="Microsoft" modified="false" />The value to replace with <paramref name="newValue." /></param>
<param name="newValue">
<attribution license="cc4" from="Microsoft" modified="false" />The new value of the installer at <paramref name="index" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public void Remove (System.Configuration.Install.Installer value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Configuration.Install.Installer" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Configuration.Install.Installer.Parent" /> property of the removed <see cref="T:System.Configuration.Install.Installer" /> is set to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes the specified <see cref="T:System.Configuration.Install.Installer" /> from the collection.</para>
</summary>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Configuration.Install.Installer" /> that represents the installer to remove. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

106
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ManagedInstallerClass.xml Normal file
View File

@@ -0,0 +1,106 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ManagedInstallerClass" FullName="System.Configuration.Install.ManagedInstallerClass">
<TypeSignature Language="C#" Value="public class ManagedInstallerClass : System.Configuration.Install.IManagedInstaller" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Configuration.Install.IManagedInstaller</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("42EB0342-0393-448f-84AA-D4BEB0283595")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a managed install.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ManagedInstallerClass ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.ManagedInstallerClass" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InstallHelper">
<MemberSignature Language="C#" Value="public static void InstallHelper (string[] args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="args" Type="System.String[]" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the functionality of the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format>.</para>
</summary>
<param name="args">
<attribution license="cc4" from="Microsoft" modified="false" />The arguments passed to the Installer Tool.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="System.Configuration.Install.IManagedInstaller.ManagedInstall">
<MemberSignature Language="C#" Value="int IManagedInstaller.ManagedInstall (string argString, int hInstall);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argString" Type="System.String" />
<Parameter Name="hInstall" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Configuration.Install.ManagedInstallerClass" /> instance is cast to an <see cref="T:System.Configuration.Install.IManagedInstaller" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For a description of this member, see <see cref="M:System.Configuration.Install.IManagedInstaller.ManagedInstall(System.String,System.Int32)" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The return code for installutil.exe. A successful installation returns 0. Other values indicate failure.</para>
</returns>
<param name="argString">
<attribution license="cc4" from="Microsoft" modified="false" />The command line to install.</param>
<param name="hInstall">
<attribution license="cc4" from="Microsoft" modified="false" />The handle to the installation.</param>
</Docs>
</Member>
</Members>
</Type>

96
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/TransactedInstaller.xml Normal file
View File

@@ -0,0 +1,96 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="TransactedInstaller" FullName="System.Configuration.Install.TransactedInstaller">
<TypeSignature Language="C#" Value="public class TransactedInstaller : System.Configuration.Install.Installer" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.Install.Installer</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To run installers in a transaction, add them to the <see cref="P:System.Configuration.Install.Installer.Installers" /> property of this <see cref="T:System.Configuration.Install.TransactedInstaller" /> instance.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines an installer that either succeeds completely or fails and leaves the computer in its initial state.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TransactedInstaller ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Configuration.Install.TransactedInstaller" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Install">
<MemberSignature Language="C#" Value="public override void Install (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method calls the <see cref="M:System.Configuration.Install.TransactedInstaller.Install(System.Collections.IDictionary)" /> method of each installer contained in the <see cref="P:System.Configuration.Install.Installer.Installers" /> property of this instance. The <see cref="T:System.Collections.IDictionary" /> object referenced by the <paramref name="savedState" /> parameter is updated to reflect the status of the installation after the contained installers have run. If all the <see cref="M:System.Configuration.Install.TransactedInstaller.Install(System.Collections.IDictionary)" /> methods succeed, the <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" /> method is called. Otherwise, the <see cref="M:System.Configuration.Install.Installer.Rollback(System.Collections.IDictionary)" /> method is called for each installer.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Performs the installation.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> in which this method saves information needed to perform a commit, rollback, or uninstall operation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Uninstall">
<MemberSignature Language="C#" Value="public override void Uninstall (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call this method to remove a previously completed installation. This <see cref="M:System.Configuration.Install.TransactedInstaller.Uninstall(System.Collections.IDictionary)" /> method calls the <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> method of each installer in the <see cref="P:System.Configuration.Install.Installer.Installers" /> property to uninstall any resources set during installation. Any exceptions during uninstallation are ignored.</para>
<block subset="none" type="note">
<para>Although the <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" /> and <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" /> methods save the state of the computer after the installations, the file containing the <see cref="T:System.Collections.IDictionary" /> from the <paramref name="savedState" /> parameter might have been deleted at some point after the installation was complete. If the file is deleted, the <paramref name="savedState" /> parameter is null.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes an installation.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the state of the computer after the installation completed. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

55
mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/UninstallAction.xml Normal file
View File

@@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="UninstallAction" FullName="System.Configuration.Install.UninstallAction">
<TypeSignature Language="C#" Value="public enum UninstallAction" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies what an installer should do during an uninstallation.</para>
</summary>
</Docs>
<Members>
<Member MemberName="NoAction">
<MemberSignature Language="C#" Value="NoAction" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Configuration.Install.UninstallAction</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Leaves the resource created by the installer as is.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="Remove" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Configuration.Install.UninstallAction</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes the resource the installer created.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

439
mcs/class/System.Configuration.Install/Documentation/en/System.Diagnostics/EventLogInstaller.xml Normal file
View File

@@ -0,0 +1,439 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="EventLogInstaller" FullName="System.Diagnostics.EventLogInstaller">
<TypeSignature Language="C#" Value="public class EventLogInstaller : System.Configuration.Install.ComponentInstaller" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.Install.ComponentInstaller</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Diagnostics.EventLogInstaller" /> is used by the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format> when installing an event log. The <see cref="T:System.Diagnostics.EventLogInstaller" /> class can install event logs only on the local computer.</para>
<para>Use the <see cref="T:System.Diagnostics.EventLogInstaller" /> class when your application writes to an event log; it is not necessary to use an event log installer for your application to read from an event log. Applications and services should write to the Application log or a custom log. Device drivers should write to the System log.</para>
<block subset="none" type="note">
<para>The Security log is read-only.</para>
</block>
<para>The installer creates the event source that you specify in the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property and registers it for the event log specified in <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property. This behavior is similar to calling <see cref="M:System.Diagnostics.EventLog.CreateEventSource(System.String,System.String)" /> on the <see cref="T:System.Diagnostics.EventLog" /> component.</para>
<para>Use the <see cref="Overload:System.Diagnostics.EventLog.WriteEvent" /> and <see cref="Overload:System.Diagnostics.EventLog.WriteEntry" /> methods to write events to an event log. You must specify an event source to write events; you must create and configure the event source before writing the first entry with the source. </para>
<para>Create the new event source during the installation of your application. This allows time for the operating system to refresh its list of registered event sources and their configurations. If the operating system has not refreshed its list of event sources, and you attempt to write an event with the new source, the write operation will fail. You can configure a new source using an <see cref="T:System.Diagnostics.EventLogInstaller" />, or using the <see cref="Overload:System.Diagnostics.EventLog.CreateEventSource" /> method. You must have administrative rights on the computer to create a new event source.</para>
<para>You can create an event source for an existing event log or a new event log. When you create a new source for a new event log, the system registers the source for that log, but the log is not created until the first entry is written to it.</para>
<para>To install an event log, create a project installer class that inherits from <see cref="T:System.Configuration.Install.Installer" />, and set the <see cref="T:System.ComponentModel.RunInstallerAttribute" /> for the class to true. Within your project, create an <see cref="T:System.Diagnostics.EventLogInstaller" /> for each event log that your application will write to and add the instance to your project installer class.</para>
<para>When the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format> is called, it looks at the <see cref="T:System.ComponentModel.RunInstallerAttribute" />. If it is true, the tool installs all the items in the <see cref="P:System.Configuration.Install.Installer.Installers" /> collection that are associated with your project installer. If <see cref="T:System.ComponentModel.RunInstallerAttribute" /> is false, the tool ignores the project installer.</para>
<para>You modify other properties of an <see cref="T:System.Diagnostics.EventLogInstaller" /> either before or after adding the instance to the <see cref="P:System.Configuration.Install.Installer.Installers" /> collection of your project installer, but before the installer tool runs. You must set the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property if your application will be writing to the event log.</para>
<para>Use <see cref="T:System.Diagnostics.EventLogInstaller" /> to register a new source for a new or existing event log; do not use <see cref="T:System.Diagnostics.EventLogInstaller" /> to change an existing source. The <see cref="T:System.Diagnostics.EventLogInstaller" /> class does not modify the configuration properties of an existing source to match the specified installation properties. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method throws an exception if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is registered for a different event log on the computer. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method does not register the source if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is already registered for the same event log specified in the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property.</para>
<para>You can register the event source with localized resource files for your event category and message strings. Your application can write event log entries using resource identifiers, rather than specifying the actual string. The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings. You can register a separate file for event categories, messages, and parameter insertion strings, or you can register the same resource file for all three types of strings. Use the <see cref="P:System.Diagnostics.EventLogInstaller.CategoryCount" />, <see cref="P:System.Diagnostics.EventLogInstaller.CategoryResourceFile" />, <see cref="P:System.Diagnostics.EventLogInstaller.MessageResourceFile" />, and <see cref="P:System.Diagnostics.EventLogInstaller.ParameterResourceFile" /> properties to configure the source to write localized entries to the event log. If your application writes strings values directly to the event log, you do not need to set these properties.</para>
<para>The source must be configured either for writing localized entries or for writing direct strings. If your application writes entries using both resource identifiers and string values, you must register two separate sources. For example, configure one source with resource files, and then use that source in the <see cref="Overload:System.Diagnostics.EventLog.WriteEvent" /> method to write entries using resource identifiers to the event log. Create a different source without resource files and then use that source in the <see cref="Overload:System.Diagnostics.EventLog.WriteEntry" /> method to write strings directly to the event log using that source.</para>
<para>Typically, you do not call the methods of the <see cref="T:System.Diagnostics.EventLogInstaller" /> class from within your code; they are generally called only by Installutil.exe. The tool automatically calls the <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method during the installation process. It backs out failures, if necessary, by calling the <see cref="M:System.Diagnostics.EventLogInstaller.Rollback(System.Collections.IDictionary)" /> method for the object that generated the exception.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Allows you to install and configure an event log that your application reads from or writes to when running. </para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventLogInstaller ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Diagnostics.EventLogInstaller" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CategoryCount">
<MemberSignature Language="C#" Value="public int CategoryCount { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Diagnostics.EventLogInstaller.CategoryCount" /> and <see cref="P:System.Diagnostics.EventLogInstaller.CategoryResourceFile" /> properties to write events with localized category strings. The Event Viewer displays the category for an event entry, if you supply a category when you write the event. Event log categories are application-defined strings that help filter events, or provide information on an event. For example, your application can define separate categories for different components or different operations.</para>
<para>Event categories are optional; if your application does not use categories, do not set the <see cref="P:System.Diagnostics.EventLogInstaller.CategoryCount" /> and <see cref="P:System.Diagnostics.EventLogInstaller.CategoryResourceFile" /> properties.</para>
<para>For details about defining event messages and building event resource files, see the "Message Compiler" topic in the Platform SDK documentation at <see cref="http://msdn.microsoft.com/">http://msdn.microsoft.com</see>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the number of categories in the category resource file.</para>
</summary>
</Docs>
</Member>
<Member MemberName="CategoryResourceFile">
<MemberSignature Language="C#" Value="public string CategoryResourceFile { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Editor("System.Windows.Forms.Design.FileNameEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Diagnostics.EventLogInstaller.CategoryCount" /> and <see cref="P:System.Diagnostics.EventLogInstaller.CategoryResourceFile" /> properties to write events with localized category strings. The Event Viewer displays the category for an event entry if you supply a category when you write the event. Event log categories are application-defined strings that help filter events, or provide information about an event. For example, your application might have separate categories for different components or different operations.</para>
<para>Event categories are optional; if your application does not use categories, do not set the <see cref="P:System.Diagnostics.EventLogInstaller.CategoryCount" /> and <see cref="P:System.Diagnostics.EventLogInstaller.CategoryResourceFile" /> properties.</para>
<para>For details about defining event messages and building event resource files, see the "Message Compiler" topic in the Platform SDK documentation at <see cref="http://msdn.microsoft.com/">http://msdn.microsoft.com</see>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the path of the resource file that contains category strings for the source.</para>
</summary>
</Docs>
</Member>
<Member MemberName="CopyFromComponent">
<MemberSignature Language="C#" Value="public override void CopyFromComponent (System.ComponentModel.IComponent component);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The component specified by the <paramref name="component" /> parameter must be an <see cref="T:System.Diagnostics.EventLog" />; otherwise, an exception is thrown.</para>
<para>Typically, you do not call the methods of the <see cref="T:System.Diagnostics.EventLogInstaller" /> from within your code; they are generally called only by the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format>. <see cref="M:System.Diagnostics.EventLogInstaller.CopyFromComponent(System.ComponentModel.IComponent)" /> is used by Installutil.exe to set the property values for the <see cref="T:System.Diagnostics.EventLogInstaller" /> to the values of an existing <see cref="T:System.Diagnostics.EventLog" />.</para>
<para>If the <see cref="P:System.Diagnostics.EventLog.Log" /> of the <see cref="T:System.Diagnostics.EventLog" /> that is passed in is an empty string (""), you must set the <see cref="P:System.Diagnostics.EventLog.Log" /> property to a valid value before the installer executes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies the property values of an <see cref="T:System.Diagnostics.EventLog" /> component that are required at installation time for an event log.</para>
</summary>
<param name="component">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.IComponent" /> to use as a template for the <see cref="T:System.Diagnostics.EventLogInstaller" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Install">
<MemberSignature Language="C#" Value="public override void Install (System.Collections.IDictionary stateSaver);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stateSaver" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method writes event log information to the registry, and associates the event log with a log that is specified by the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property. If the log does not already exist (and a source is specified), <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> creates a log and associates the new source with it.</para>
<para>Typically, you do not call the methods of the <see cref="T:System.Diagnostics.EventLogInstaller" /> from within your code; they are generally called only by the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format>. The tool automatically calls the <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method during the installation process to write registry information that is associated with the event log being installed. Installation is transactional, so if there is a failure of any installation project component during the installation, all the previously-installed components are rolled back to their pre-installation states. This is accomplished by calling each component's <see cref="M:System.Diagnostics.EventLogInstaller.Rollback(System.Collections.IDictionary)" /> method.</para>
<para>Use <see cref="T:System.Diagnostics.EventLogInstaller" /> to register a new source for a new or existing event log; do not use <see cref="T:System.Diagnostics.EventLogInstaller" /> to change an existing source. The <see cref="T:System.Diagnostics.EventLogInstaller" /> class does not modify the configuration properties of an existing source to match the specified installation properties. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method throws an exception if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is registered for a different event log on the computer. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method skips registering the source if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is already registered for the same event log specified in the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property.</para>
<para>An application's install routine uses the project installer's <see cref="P:System.Configuration.Install.Installer.Context" /> property to automatically maintain information about the components that have already been installed. This state information, which is passed to <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> as the <paramref name="stateSaver" /> parameter, is continuously updated as the tool installs each <see cref="T:System.Diagnostics.EventLogInstaller" />. Usually, it is not necessary for your code to explicitly modify this state information.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Performs the installation and writes event log information to the registry.</para>
</summary>
<param name="stateSaver">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> used to save information needed to perform a rollback or uninstall operation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsEquivalentInstaller">
<MemberSignature Language="C#" Value="public override bool IsEquivalentInstaller (System.Configuration.Install.ComponentInstaller otherInstaller);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="otherInstaller" Type="System.Configuration.Install.ComponentInstaller" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Typically, you do not call the methods of the <see cref="T:System.Diagnostics.EventLogInstaller" /> from within your code; they are generally called only by the Installer tool (Installutil.exe).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether an installer and another specified installer refer to the same source.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if this installer and the installer specified by the <paramref name="otherInstaller" /> parameter would install or uninstall the same source; otherwise, false.</para>
</returns>
<param name="otherInstaller">
<attribution license="cc4" from="Microsoft" modified="false" />The installer to compare. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Log">
<MemberSignature Language="C#" Value="public string Log { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can use the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property to associate the source you specify in the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property with either an existing log or a new log on the local computer. The <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format> uses this information to map the source to the log in the computer's registry. Applications and services should write to the Application log or a custom log. Device drivers should write to the System log.</para>
<para>To write entries to an event log, you must create a source and register it with an event log. An event source can only write to one log at a time. The installer uses the value of the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property to register your application with the event log as a valid source of entries. If you do not specify a log name before the installer runs, the installer registers your source to the Application log. If you specify a new source and an existing log, the installer creates a new event source and associates it with the log you specify. If you specify both a new source and a new log, the installer associates the new source with the new log in the registry, but the log is not created until the first entry is written to it.</para>
<para>The operating system stores event logs as files. When you use <see cref="T:System.Diagnostics.EventLogInstaller" /> or the <see cref="Overload:System.Diagnostics.EventLog.CreateEventSource" /> method to create a new event log, the associated file is stored in the %SystemRoot%\System32\Config directory on the specified computer. The file name is set by appending the first 8 characters of the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property with the ".evt" file name extension.</para>
<para>Use <see cref="T:System.Diagnostics.EventLogInstaller" /> to register a new source for a new or existing event log; do not use <see cref="T:System.Diagnostics.EventLogInstaller" /> to change an existing source. The <see cref="T:System.Diagnostics.EventLogInstaller" /> class does not modify the configuration properties of an existing source to match the specified installation properties. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method throws an exception if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is registered for a different event log on the computer. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method does not register the source if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is already registered for the same event log specified in the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property.</para>
<para>For more detailed information about the behaviors of event logs and sources, see the <see cref="T:System.Diagnostics.EventLog" /> class documentation for the <see cref="P:System.Diagnostics.EventLog.Log" /> and <see cref="P:System.Diagnostics.EventLog.Source" /> properties.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the log to set the source to.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MessageResourceFile">
<MemberSignature Language="C#" Value="public string MessageResourceFile { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Editor("System.Windows.Forms.Design.FileNameEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Diagnostics.EventLogInstaller.MessageResourceFile" /> property to configure an event log source to write localized event messages. Event messages are application-defined strings that describe the event to the user.</para>
<para>Your application can write event log entries using resource identifiers. A resource identifier indexes a message located in the <see cref="P:System.Diagnostics.EventLogInstaller.MessageResourceFile" />. The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings.</para>
<para>The event source must be configured either for writing localized entries or for writing direct strings. Use the <see cref="Overload:System.Diagnostics.EventLog.WriteEvent" /> method to write localized entries for a source configured with a message resource file.</para>
<para>If your application writes event message strings directly, rather than using a resource identifier in a localized resource file, do not set the <see cref="P:System.Diagnostics.EventLogInstaller.MessageResourceFile" /> property.</para>
<para>If the <see cref="P:System.Diagnostics.EventLog.MachineName" /> property is not the local computer identifier ("."), the .NET Framework assumes that the resource file is on a remote computer. If the <see cref="P:System.Diagnostics.EventLogInstaller.MessageResourceFile" /> property value contains a drive letter, the resource file is assumed to be on the \\&lt;machinename&gt;\&lt;drive&gt;$ share (for example, \\server\c$). If the value contains the string %systemroot%, the resource file is assumed to be on the \\&lt;machinename&gt;\admin$ share (for example, \\server\admin$).</para>
<para>For details about defining event messages and building event resource files, see the "Message Compiler" topic in the Platform SDK documentation at <see cref="http://msdn.microsoft.com/">http://msdn.microsoft.com</see>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the path of the resource file that contains message formatting strings for the source.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ParameterResourceFile">
<MemberSignature Language="C#" Value="public string ParameterResourceFile { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Editor("System.Windows.Forms.Design.FileNameEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Diagnostics.EventLogInstaller.ParameterResourceFile" /> property to configure an event log source to write localized event messages with inserted parameter strings. Each localized event message specified in the <see cref="P:System.Diagnostics.EventLogInstaller.MessageResourceFile" /> property can contain placeholders for insertion strings. These placeholders are used to specify the position and resource identifier for a language-independent string within the event message. The Event Viewer replaces the placeholders with the corresponding strings from the <see cref="P:System.Diagnostics.EventLogInstaller.ParameterResourceFile" /> and formats the event log message for the localized event entry.</para>
<para>For example, the following section of a message text file defines a string with a parameter placeholder:</para>
<code>
MessageId = 1501
Severity = Success
Facility = Application
SymbolicName = COMPONENT_STARTING
Language=English
Component %%6050 is starting.
.</code>
<para>Within the parameter resource file, the insertion string must be defined with the resource identifier that corresponds to the placeholder, as shown below:</para>
<code>MessageId = 6050
Severity = Success
Facility = Application
SymbolicName = COMPONENT_NAME_MSGID
Language=English
TRIGGER.EXE
.</code>
<para>The event source must be configured either for writing localized entries or for writing direct strings. Use the <see cref="Overload:System.Diagnostics.EventLog.WriteEvent" /> method to write localized entries for a source configured with a message resource file.</para>
<para>If your application writes event message strings directly to the event log, or if your <see cref="P:System.Diagnostics.EventLogInstaller.MessageResourceFile" /> does not contain messages with parameter insertion placeholders, do not set the <see cref="P:System.Diagnostics.EventLogInstaller.ParameterResourceFile" /> property.</para>
<para>For details about defining event messages and building event resource files, see the "Message Compiler" topic in the Platform SDK documentation at <see cref="http://msdn.microsoft.com/">http://msdn.microsoft.com</see>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the path of the resource file that contains message parameter strings for the source.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Rollback">
<MemberSignature Language="C#" Value="public override void Rollback (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Diagnostics.EventLogInstaller.Rollback(System.Collections.IDictionary)" /> method undoes the effects of the <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method. <see cref="M:System.Diagnostics.EventLogInstaller.Rollback(System.Collections.IDictionary)" /> is called if the installation of any component in the installation project fails. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method creates or sets the properties for an event log and event source. <see cref="M:System.Diagnostics.EventLogInstaller.Rollback(System.Collections.IDictionary)" /> either deletes the event log and source or resets the properties of a pre-existing source to its pre-installation values.</para>
<para>Typically, you do not call the methods of the <see cref="T:System.Diagnostics.EventLogInstaller" /> from within your code; they are generally called only by the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format>. The tool calls the <see cref="M:System.Diagnostics.EventLogInstaller.Rollback(System.Collections.IDictionary)" /> method, when this or another component has failed to install, to undo any changes that the installation process has already made.</para>
<para>An application's install routine uses the project installer's <see cref="P:System.Configuration.Install.Installer.Context" /> property to automatically maintain information about the components that have already been installed. This state information, which is passed to <see cref="M:System.Diagnostics.EventLogInstaller.Rollback(System.Collections.IDictionary)" /> as the <paramref name="savedState" /> parameter, is continuously updated as the tool rolls back each <see cref="T:System.Diagnostics.EventLogInstaller" />. Usually, it is not necessary for your code to explicitly modify this state information.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Restores the computer to the state it was in before the installation by rolling back the event log information that the installation procedure wrote to the registry.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the pre-installation state of the computer. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Source">
<MemberSignature Language="C#" Value="public string Source { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The event source indicates what logs the event. It is often the name of the application, or the name of a component within a large application.</para>
<para>The installer uses the value of the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property to register your application with the event log as a valid source of entries. A new source name cannot match an existing source name or an existing event log name. Each source can only write to one event log at a time; however, your application can use multiple sources to write to multiple event logs. For example, your application might require multiple sources configured for different event logs or different resource files.</para>
<para>Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. If you do not specify a log name before the installer runs, the installer registers your source to the Application log. If you specify the name of a log that does not exist, the system registers the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> to that log, but the log is not created until the first entry is written to it.</para>
<para>Use <see cref="T:System.Diagnostics.EventLogInstaller" /> to register a new source for a new or existing event log; do not use <see cref="T:System.Diagnostics.EventLogInstaller" /> to change an existing source. The <see cref="T:System.Diagnostics.EventLogInstaller" /> class does not modify the configuration properties of an existing source to match the specified installation properties. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method throws an exception if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is registered for a different event log on the computer. The <see cref="M:System.Diagnostics.EventLogInstaller.Install(System.Collections.IDictionary)" /> method does not register the source if the <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> property matches a source name that is already registered for the same event log specified in the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> property.</para>
<para>For more detailed information about the behaviors of event logs and sources, see the <see cref="T:System.Diagnostics.EventLog" /> class documentation for the <see cref="P:System.Diagnostics.EventLog.Log" /> and <see cref="P:System.Diagnostics.EventLog.Source" /> properties.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the source name to register with the log.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Uninstall">
<MemberSignature Language="C#" Value="public override void Uninstall (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <see cref="P:System.Diagnostics.EventLogInstaller.UninstallAction" /> property value is Remove, the <see cref="M:System.Diagnostics.EventLogInstaller.Uninstall(System.Collections.IDictionary)" /> method deletes the source and the associated log that the installer created if the <see cref="P:System.Diagnostics.EventLogInstaller.Log" /> and <see cref="P:System.Diagnostics.EventLogInstaller.Source" /> properties specified the creation of a new event log and source.</para>
<para>Typically, you do not call the methods of the <see cref="T:System.Diagnostics.EventLogInstaller" /> from within your code; they are generally called only by the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format> in uninstall mode. The tool automatically calls the <see cref="M:System.Diagnostics.EventLogInstaller.Uninstall(System.Collections.IDictionary)" /> method to restore the parts of the system that were affected by the installation to their pre-installation states. This includes deleting registry information that is associated with the event log being uninstalled.</para>
<para>An application's uninstall routine uses the project installer's <see cref="P:System.Configuration.Install.Installer.Context" /> property to automatically maintain information about the components that have already been uninstalled. This state information, which is passed to <see cref="M:System.Diagnostics.EventLogInstaller.Uninstall(System.Collections.IDictionary)" /> as the <paramref name="savedState" /> parameter, is continuously updated as the tool uninstalls each <see cref="T:System.Diagnostics.EventLogInstaller" />. Usually, it is not necessary for your code to explicitly modify this state information.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes an installation by removing event log information from the registry.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the pre-installation state of the computer. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UninstallAction">
<MemberSignature Language="C#" Value="public System.Configuration.Install.UninstallAction UninstallAction { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(System.Configuration.Install.UninstallAction.Remove)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.Install.UninstallAction</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When you install an event log, you can optionally connect it to an existing log. If you do so, you must decide whether the log should return to its pre-installation state, or remain in its current, post-installation state. If you elect to return the event log to its pre-installation state, changes to the event log entries at installation are not restored. You can reset only the event log properties that are associated with the <see cref="T:System.Diagnostics.EventLogInstaller" /> to their pre-installation values.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether the <format type="text/html"><a href="3f9d0533-f895-4897-b4ea-528284e0241d">Installer Tool (Installutil.exe)</a></format> should remove the event log or leave it in its installed state at uninstall time.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

270
mcs/class/System.Configuration.Install/Documentation/en/System.Diagnostics/PerformanceCounterInstaller.xml Normal file
View File

@@ -0,0 +1,270 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="PerformanceCounterInstaller" FullName="System.Diagnostics.PerformanceCounterInstaller">
<TypeSignature Language="C#" Value="public class PerformanceCounterInstaller : System.Configuration.Install.ComponentInstaller" />
<AssemblyInfo>
<AssemblyName>System.Configuration.Install</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.Install.ComponentInstaller</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following information might help provide a performance improvement when installing performance counters at application startup. Performance counter categories installed with .NET Framework version 2.0 use separate shared memories, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\&lt;category name&gt;\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the fileMappingSize attribute value for the performanceCounters element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies an installer for the <see cref="T:System.Diagnostics.PerformanceCounter" /> component.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PerformanceCounterInstaller ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Diagnostics.PerformanceCounterInstaller" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CategoryHelp">
<MemberSignature Language="C#" Value="public string CategoryHelp { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the descriptive message for the performance counter.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CategoryName">
<MemberSignature Language="C#" Value="public string CategoryName { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the performance category name for the performance counter.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CategoryType">
<MemberSignature Language="C#" Value="public System.Diagnostics.PerformanceCounterCategoryType CategoryType { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(System.Diagnostics.PerformanceCounterCategoryType.Unknown)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Diagnostics.PerformanceCounterCategoryType</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Diagnostics.PerformanceCounterInstaller.CategoryType" /> property specifies whether the performance counter category can have multiple instances. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the performance counter category type.</para>
</summary>
</Docs>
</Member>
<Member MemberName="CopyFromComponent">
<MemberSignature Language="C#" Value="public override void CopyFromComponent (System.ComponentModel.IComponent component);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Diagnostics.PerformanceCounterInstaller" /> can only install multiple counters in the same category.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies all the properties from the specified component that are required at install time for a performance counter.</para>
</summary>
<param name="component">
<attribution license="cc4" from="Microsoft" modified="false" />The component to copy from. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Counters">
<MemberSignature Language="C#" Value="public System.Diagnostics.CounterCreationDataCollection Counters { get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Diagnostics.CounterCreationDataCollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a collection of data that pertains to the counters to install.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Install">
<MemberSignature Language="C#" Value="public override void Install (System.Collections.IDictionary stateSaver);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stateSaver" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<block subset="none" type="note">
<para>When installing both a service and a performance counter with the same name, install the service before installing the performance counter.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Performs the installation.</para>
</summary>
<param name="stateSaver">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that is used to save the information needed to perform a commit, rollback, or uninstall operation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Rollback">
<MemberSignature Language="C#" Value="public override void Rollback (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Restores the computer to the state it was in before the installation.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the pre-installation state of the computer. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Uninstall">
<MemberSignature Language="C#" Value="public override void Uninstall (System.Collections.IDictionary savedState);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="savedState" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes an installation.</para>
</summary>
<param name="savedState">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> that contains the post-installation state of the computer. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UninstallAction">
<MemberSignature Language="C#" Value="public System.Configuration.Install.UninstallAction UninstallAction { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(System.Configuration.Install.UninstallAction.Remove)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.Install.UninstallAction</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether the performance counter should be removed at uninstall time.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

79
mcs/class/System.Configuration.Install/Documentation/en/index.xml Normal file
View File

@@ -0,0 +1,79 @@
<Overview>
<Assemblies>
<Assembly Name="System.Configuration.Install" Version="2.0.0.0">
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComCompatibleVersion(1, 0, 3300, 0)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.CompilationRelaxations(System.Runtime.CompilerServices.CompilationRelaxations.NoStringInterning)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Diagnostics.Debuggable(System.Diagnostics.DebuggableAttribute+DebuggingModes.IgnoreSymbolStoreSequencePoints)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyFileVersion("2.0.50727.1433")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Resources.NeutralResourcesLanguage("en-US")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.CLSCompliant(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyInformationalVersion("2.0.50727.1433")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Resources.SatelliteContractVersion("2.0.0.0")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyCopyright("(c) various MONO Authors")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyProduct("MONO Common language infrastructure")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyCompany("MONO development team")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyDefaultAlias("System.Configuration.Install.dll")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyDescription("System.Configuration.Install.dll")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyTitle("System.Configuration.Install.dll")</AttributeName>
</Attribute>
</Attributes>
</Assembly>
</Assemblies>
<Remarks>To be added.</Remarks>
<Copyright>To be added.</Copyright>
<Types>
<Namespace Name="System.Configuration.Install">
<Type Name="AssemblyInstaller" Kind="Class" />
<Type Name="ComponentInstaller" Kind="Class" />
<Type Name="IManagedInstaller" Kind="Interface" />
<Type Name="InstallContext" Kind="Class" />
<Type Name="Installer" Kind="Class" />
<Type Name="InstallerCollection" Kind="Class" />
<Type Name="InstallEventArgs" Kind="Class" />
<Type Name="InstallEventHandler" Kind="Delegate" />
<Type Name="InstallException" Kind="Class" />
<Type Name="ManagedInstallerClass" Kind="Class" />
<Type Name="TransactedInstaller" Kind="Class" />
<Type Name="UninstallAction" Kind="Enumeration" />
</Namespace>
<Namespace Name="System.Diagnostics">
<Type Name="EventLogInstaller" Kind="Class" />
<Type Name="PerformanceCounterInstaller" Kind="Class" />
</Namespace>
</Types>
<Title>System.Configuration.Install</Title>
</Overview>

15
mcs/class/System.Configuration.Install/Documentation/en/ns-System.Configuration.Install.xml Normal file
View File

@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<Namespace Name="System.Configuration.Install">
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="N:System.Configuration.Install" /> namespace provides classes that allow you to write custom installers for your own components. The <see cref="T:System.Configuration.Install.Installer" /> class is the base class for all custom installers in the.NET Framework.</para>
</summary>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Through the <see cref="P:System.Configuration.Install.Installer.Installers" /> property, an installer contains a collection of other installers as children. As the installer is executed, it cycles through its children and calls <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Rollback(System.Collections.IDictionary)" />, or <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" />. For an example of an object in the <see cref="P:System.Configuration.Install.Installer.Installers" /> collection, see <see cref="T:System.Diagnostics.EventLogInstaller" />.</para>
<para>The <see cref="P:System.Configuration.Install.Installer.Context" /> property contains information about the installation. For example, information about the location of the log file for the installation, the location of the file that saves information required by the <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> method, and the command line that was entered when the installation executable was run. For an example of an installation executable, see <format type="text/html"><a href="3F9D0533-F895-4897-B4EA-528284E0241D">Installer Tool (Installutil.exe)</a></format>.</para>
<para>The <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Rollback(System.Collections.IDictionary)" />, and <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> methods are not always called on the same instance of <see cref="T:System.Configuration.Install.Installer" />. For example, you might use an <see cref="T:System.Configuration.Install.Installer" /> to install and commit an application, and then release the reference to that <see cref="T:System.Configuration.Install.Installer" />. Later, uninstalling the application creates a new reference to an <see cref="T:System.Configuration.Install.Installer" />, which means that the <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> method is called on a different instance of <see cref="T:System.Configuration.Install.Installer" />. For this reason, do not save the state of a computer in an installer. Instead, use an <see cref="T:System.Collections.IDictionary" /> that is preserved across calls and passed into the <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Commit(System.Collections.IDictionary)" />, <see cref="M:System.Configuration.Install.Installer.Rollback(System.Collections.IDictionary)" />, and <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> methods.</para>
</remarks>
</Docs>
</Namespace>

6
mcs/class/System.Configuration.Install/Documentation/en/ns-System.Diagnostics.xml Normal file
View File

@@ -0,0 +1,6 @@
<Namespace Name="System.Diagnostics">
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Namespace>