<regasm>

[This is preliminary documentation and subject to change.]

Registers an assembly 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 fileset.	False
codebase	bool	Set the code base registry setting.	False
exporttypelib	bool	Export a typelib and register it. The typelib will have the same name as the source assembly unless the `typelib` attribute is used.	False
regfile	file	Registry file to export to instead of entering the types directly into the registry. If a fileset is used then the entries are all collated into this file.	False
registered	bool	Only refer to already registered type libraries.	False
typelib	file	Export the assembly to the specified type library and register it. This attribute is ignored when a fileset is specified.	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 `if`. 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
useruntimeengine	bool	Specifies whether the external program should be executed using a runtime engine, if configured. The default is false.	False

Nested Elements:

<fileset>

The set of files to register.

</fileset>

<arg>

The command-line arguments for the external program.

Represents a command-line argument.

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	<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>

Examples

Register a single assembly.

<regasm assembly="myAssembly.dll" />

Register an assembly while exporting a typelibrary.

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

Register a set of assemblies at once.

<regasm unregister="false" codebase="true">
    <fileset>
        <include name="**/*.dll" />
      <exclude name="notanassembly.dll" />
    </fileset>
</regasm>

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.2344.0)