<regasm>

Registers an assembly, or set of assemblies for use from COM clients.

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

Parameters

Attribute Type Description Required
assembly file
The name of the file to register. This is provided as an alternate to using the task's NAnt.Win32.Tasks.RegAsmTask.Assemblies.
False
codebase bool
Set the code base registry setting.
False
registered bool
Only refer to already registered type libraries.
False
regfile file
Registry file to export to instead of entering the types directly into the registry.
False
typelib file
Export the assemblies to the specified type library and register it.
False
unregister bool
Unregister the assembly. The default is false.
False
failonerror bool
Determines if task failure stops the build, or is just reported. The default is true.
False
if bool
If true then the task will be executed; otherwise, skipped. The default is true.
False
timeout int
The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.
False
unless bool
Opposite of NAnt.Core.Task.IfDefined. If false then the task will be executed; otherwise, skipped. The default is false.
False
verbose bool
Determines whether the task should report detailed build log messages. The default is false.
False

Framework-configurable parameters

Attribute Type Description Required
exename string
The name of the executable that should be used to launch the external program.
False
managed
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.
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.
Obsolete. Use the managed attribute and Managed property instead.
False

Nested elements

<arg>

The command-line arguments for the external program.

When passed to an external application, the argument will be quoted when appropriate. This does not apply to the NAnt.Core.Types.Argument.Line parameter, which is always passed as is.

Parameters

Attribute Type Description Required
dir directory
The value for a directory-based command-line argument; will be replaced with the absolute path of the directory.
False
file file
The name of a file as a single command-line argument; will be replaced with the absolute filename of the file.
False
if bool
Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true.
False
line string
List of command-line arguments; will be passed to the executable as is.
False
path
The value for a PATH-like command-line argument; you can use : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables.
False
unless bool
Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false.
False
value string
A single command-line argument; can contain space characters.
False

Nested elements

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

A single command-line argument containing a space character. 

<arg value="-l -a" />

Two separate command-line arguments. 

<arg line="-l -a" />

A single command-line argument with the value \dir;\dir2;\dir3 on DOS-based systems and /dir:/dir2:/dir3 on Unix-like systems. 

<arg path="/dir;/dir2:\dir3" />

<arg>

<assemblies>

The set of assemblies to register, or unregister.

</assemblies>

<references>

The set of assembly references.

</references>

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>

Requirements

Assembly
NAnt.Win32.dll
Namespace
NAnt.Win32.Tasks