RegAsmTask Class

Summary

Registers an assembly, or set of assemblies for use from COM clients.
Assembly
NAnt.Win32.dll
Namespace
NAnt.Win32.Tasks
Interfaces
Base Types
graph BT Type-->Base0["ExternalProgramBase"] click Base0 "/api/NAnt.Core.Tasks/ExternalProgramBase" Base0-->Base1["Task"] click Base1 "/api/NAnt.Core/Task" Base1-->Base2["Element"] click Base2 "/api/NAnt.Core/Element" Base2-->Base3["Object"] Type-.->Interface0["IConditional"] click Interface0 "/api/NAnt.Core/IConditional" Type["RegAsmTask"] class Type type-node

Syntax

[TaskName("regasm")]
[ProgramLocation(LocationType.FrameworkDir)]
public class RegAsmTask : ExternalProgramBase, IConditional

Examples

Register types in a single assembly. 

<regasm assembly="myAssembly.dll" />

Register types of an assembly and generate a type library containing definitions of accessible types defined within the assembly. 

<regasm assembly="myAssembly.dll" typelib="myAssembly.tlb" />

Register types of set of assemblies at once, while specifying a set of reference assemblies. 

    <regasm codebase="true">
    <assemblies>
        <include name="OutlookAddin.dll" />
        <include name="OfficeCoreAddin.dll" />
    </assemblies>
    <references>
        <include name="CommonTypes.dll" />
    </references>
</regasm>

Remarks

Refer to the Regasm documentation for more information on the regasm tool.

Attributes

Type Description
TaskNameAttribute Indicates that class should be treated as a task.
ProgramLocationAttribute Indicates the location that a task executable can be located in.

Fields

Name Constant Value Summary
UnknownExitCode -1000
Defines the exit code that will be returned by NAnt.Core.Tasks.ExternalProgramBase.ExitCode if the process could not be started, or did not exit (in time).
Inherited from ExternalProgramBase
static

Properties

Name Value Summary
Arguments ArgumentCollection
The command-line arguments for the external program.
Inherited from ExternalProgramBase
Assemblies AssemblyFileSet
The set of assemblies to register, or unregister.
AssemblyFile FileInfo
The name of the file to register. This is provided as an alternate to using the task's NAnt.Win32.Tasks.RegAsmTask.Assemblies.
BaseDirectory DirectoryInfo
Gets the working directory for the application.
CodeBase bool
Set the code base registry setting.
CommandLine string
Gets the command-line arguments, separated by spaces.
Inherited from ExternalProgramBase
CustomXmlProcessing bool
Gets a value indicating whether the element is performing additional processing using the NAnt.Core.Element.XmlNode that was used to initialize the element.
Inherited from Element
ErrorWriter TextWriter
Gets or sets the System.IO.TextWriter to which error output of the external program will be written.
Inherited from ExternalProgramBase
ExeName string
The name of the executable that should be used to launch the external program.
Inherited from ExternalProgramBase
ExitCode int
Gets the value that the process specified when it terminated.
Inherited from ExternalProgramBase
FailOnError bool
Determines if task failure stops the build, or is just reported. The default is true.
Inherited from Task
IfDefined bool
If true then the task will be executed; otherwise, skipped. The default is true.
Inherited from Task
Location Location
Gets or sets the location in the build file where the element is defined.
Inherited from Element
LogPrefix string
The prefix used when sending messages to the log.
Inherited from Task
Managed ManagedExecution
Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR.
Inherited from ExternalProgramBase
Name string
The name of the task.
Inherited from Task
NamespaceManager XmlNamespaceManager
Gets or sets the System.Xml.XmlNamespaceManager.
Inherited from Element
Output FileInfo
Gets the file to which the standard output should be redirected.
Inherited from ExternalProgramBase
OutputAppend bool
Gets a value indicating whether output will be appended to the NAnt.Core.Tasks.ExternalProgramBase.Output.
Inherited from ExternalProgramBase
OutputWriter TextWriter
Gets or sets the System.IO.TextWriter to which standard output messages of the external program will be written.
Inherited from ExternalProgramBase
Parent Object
Gets or sets the parent of the element.
Inherited from Element
ProcessId int
Gets the unique identifier for the spawned application.
Inherited from ExternalProgramBase
ProgramArguments string
Gets the command line arguments for the external program.
ProgramFileName string
Gets the filename of the external program to start.
Project Project
Gets or sets the NAnt.Core.Element.Project to which this element belongs.
Inherited from Element
Properties PropertyDictionary
Gets the properties local to this NAnt.Core.Element and the NAnt.Core.Element.Project.
Inherited from Element
References AssemblyFileSet
The set of assembly references.
Registered bool
Only refer to already registered type libraries.
RegistryFile FileInfo
Registry file to export to instead of entering the types directly into the registry.
Spawn bool
Gets or sets a value indicating whether the application should be spawned. If you spawn an application, its output will not be logged by NAnt. The default is false.
Inherited from ExternalProgramBase
Threshold Level
Gets or sets the log threshold for this NAnt.Core.Task. By default the threshold of a task is NAnt.Core.Level.Debug, causing no messages to be filtered in the task itself.
Inherited from Task
TimeOut int
The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.
Inherited from ExternalProgramBase
TypeLib FileInfo
Export the assemblies to the specified type library and register it.
UnlessDefined bool
Opposite of NAnt.Core.Task.IfDefined. If false then the task will be executed; otherwise, skipped. The default is false.
Inherited from Task
Unregister bool
Unregister the assembly. The default is false.
UseRuntimeEngine bool
Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false.
Inherited from ExternalProgramBase
Verbose bool
Determines whether the task should report detailed build log messages. The default is false.
Inherited from Task
XmlNode XmlNode
Gets or sets the XML node of the element.
Inherited from Element

Methods

Name Value Summary
CopyTo(Element) void
Copies all instance data of the NAnt.Core.Element to a given NAnt.Core.Element.
Inherited from Element
Execute() void
Executes the task unless it is skipped.
Inherited from Task
ExecuteTask() void
Registers or unregisters a single assembly, or a group of assemblies.
GetAttributeConfigurationNode(FrameworkInfo, string) XmlNode
Locates the XML node for the specified attribute in either the configuration section of the extension assembly or the.project.
Inherited from Task
GetAttributeConfigurationNode(XmlNode, FrameworkInfo, string) XmlNode
Inherited from Element
GetLocation() Location
Retrieves the location in the build file where the element is defined.
Inherited from Element
Initialize() void
Initializes the task.
Inherited from Task
Initialize(XmlNode) void
Performs default initialization.
Inherited from Element
InitializeBuildElement(Element, XmlNode, Element, Type) Element
Initializes the build element.
Inherited from Element
static
InitializeElement(XmlNode) void
Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
Inherited from Element
InitializeTask(XmlNode) void
Initializes the task.
Inherited from Task
InitializeTaskConfiguration() void
Initializes the configuration of the task using configuration settings retrieved from the NAnt configuration file.
Inherited from Task
InitializeXml(XmlNode, PropertyDictionary, FrameworkInfo) void
Initializes all build attributes and child elements.
Inherited from Element
IsLogEnabledFor(Level) bool
Determines whether build output is enabled for the given NAnt.Core.Level.
Inherited from Task
Log(Level, string) void
Logs a message with the given priority.
Inherited from Task
Log(Level, string, Object[]) void
Logs a formatted message with the given priority.
Inherited from Task
PrepareProcess(Process) void
Updates the System.Diagnostics.ProcessStartInfo of the specified System.Diagnostics.Process.
StartProcess() Process
Starts the process and handles errors.
Inherited from ExternalProgramBase