← Back to branch summary

~mandel/ubuntuone-windows-installer/update_nunit_net_4

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/tasks/regsvcs.html

  • Committer: Manuel de la Pena
  • Date: 2010-10-12 13:38:14 UTC
  • Revision ID: mandel@themacaque.com-20101012133814-nxp9kr2lx2jygmmx
Updated nant to work with .Net 4.0 and removed useless docs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/Nant/doc/help/tasks/regsvcs.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2
 
<html xmlns="http://www.w3.org/1999/xhtml">
3
 
  <!-- Documenting T:NAnt.DotNet.Tasks.RegsvcsTask-->
4
 
  <head>
5
 
    <meta http-equiv="Content-Language" content="en-ca" />
6
 
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
 
    <link rel="stylesheet" type="text/css" href="../style.css" />
8
 
    <title>&lt;regsvcs&gt; Task</title>
9
 
  </head>
10
 
  <body>
11
 
    <table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
12
 
      <tr>
13
 
        <td class="NavBar-Cell">
14
 
          <a href="http://nant.sourceforge.net">
15
 
            <b>NAnt</b>
16
 
          </a>
17
 
          <img alt="-&gt;" src="../images/arrow.gif" />
18
 
          <a href="../index.html">Help</a>
19
 
          <img alt="-&gt;" src="../images/arrow.gif" />
20
 
          <a href="../tasks/index.html">Task Reference</a>
21
 
          <img alt="-&gt;" src="../images/arrow.gif" /> &lt;regsvcs&gt;</td>
22
 
        <td class="NavBar-Cell" align="right">
23
 
                        v0.90</td>
24
 
      </tr>
25
 
    </table>
26
 
    <h1>&lt;regsvcs&gt;</h1>
27
 
    <p> Installs or removes .NET Services. </p>
28
 
    <p> This tasks provides the same functionality as the <code>regsvcs</code> tool provided in the .NET SDK. </p>
29
 
    <p> It performs the following actions: </p>
30
 
    <ul style="list-style-type: disc;">
31
 
      <li>Loads and registers an assembly.</li>
32
 
      <li>Generates, registers, and installs a type library into a specified COM+ application.</li>
33
 
      <li>Configures services that are added programmatically to your class.</li>
34
 
    </ul>
35
 
    <p> Refer to the <a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrfnetservicesinstallationutilityregsvcsexe.htm">.NET Services Installation Tool (Regsvcs.exe)</a> for more information. </p>
36
 
    <h3>Parameters</h3>
37
 
    <div class="table">
38
 
      <table>
39
 
        <tr>
40
 
          <th>Attribute</th>
41
 
          <th style="text-align: center;">Type</th>
42
 
          <th>Description</th>
43
 
          <th style="text-align: center;">Required</th>
44
 
        </tr>
45
 
        <tr>
46
 
          <td valign="top" class="required">assembly</td>
47
 
          <td style="text-align: center;">file</td>
48
 
          <td> The source assembly file. </td>
49
 
          <td style="text-align: center;">True</td>
50
 
        </tr>
51
 
        <tr>
52
 
          <td valign="top">action</td>
53
 
          <td style="text-align: center;">
54
 
            <a href="../enums/NAnt.DotNet.Tasks.RegsvcsTask.ActionType.html">ActionType</a>
55
 
          </td>
56
 
          <td> Defines the action to take with the assembly. The default is <code>FindOrCreate</code>. </td>
57
 
          <td style="text-align: center;">False</td>
58
 
        </tr>
59
 
        <tr>
60
 
          <td valign="top">application</td>
61
 
          <td style="text-align: center;">string</td>
62
 
          <td> Specifies the name of the COM+ application to either find or create. </td>
63
 
          <td style="text-align: center;">False</td>
64
 
        </tr>
65
 
        <tr>
66
 
          <td valign="top">componentsonly</td>
67
 
          <td style="text-align: center;">bool</td>
68
 
          <td> Configures components only; ignores methods and interfaces. The default is <b>false</b>. </td>
69
 
          <td style="text-align: center;">False</td>
70
 
        </tr>
71
 
        <tr>
72
 
          <td valign="top">existingapp</td>
73
 
          <td style="text-align: center;">bool</td>
74
 
          <td> Expect an existing application. The default is <b>false</b>. </td>
75
 
          <td style="text-align: center;">False</td>
76
 
        </tr>
77
 
        <tr>
78
 
          <td valign="top">existingtlb</td>
79
 
          <td style="text-align: center;">bool</td>
80
 
          <td> Uses an existing type library. The default is <b>false</b>. </td>
81
 
          <td style="text-align: center;">False</td>
82
 
        </tr>
83
 
        <tr>
84
 
          <td valign="top">noreconfig</td>
85
 
          <td style="text-align: center;">bool</td>
86
 
          <td> Do not reconfigure an existing target application. The default is <b>false</b>. </td>
87
 
          <td style="text-align: center;">False</td>
88
 
        </tr>
89
 
        <tr>
90
 
          <td valign="top">partition</td>
91
 
          <td style="text-align: center;">string</td>
92
 
          <td> Specifies the name or id of the COM+ application to either find or create. </td>
93
 
          <td style="text-align: center;">False</td>
94
 
        </tr>
95
 
        <tr>
96
 
          <td valign="top">tlb</td>
97
 
          <td style="text-align: center;">file</td>
98
 
          <td> Specifies the type library file to install. </td>
99
 
          <td style="text-align: center;">False</td>
100
 
        </tr>
101
 
        <tr>
102
 
          <td valign="top">failonerror</td>
103
 
          <td style="text-align: center;">bool</td>
104
 
          <td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
105
 
          <td style="text-align: center;">False</td>
106
 
        </tr>
107
 
        <tr>
108
 
          <td valign="top">if</td>
109
 
          <td style="text-align: center;">bool</td>
110
 
          <td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
111
 
          <td style="text-align: center;">False</td>
112
 
        </tr>
113
 
        <tr>
114
 
          <td valign="top">timeout</td>
115
 
          <td style="text-align: center;">int</td>
116
 
          <td> The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. </td>
117
 
          <td style="text-align: center;">False</td>
118
 
        </tr>
119
 
        <tr>
120
 
          <td valign="top">unless</td>
121
 
          <td style="text-align: center;">bool</td>
122
 
          <td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
123
 
          <td style="text-align: center;">False</td>
124
 
        </tr>
125
 
        <tr>
126
 
          <td valign="top">verbose</td>
127
 
          <td style="text-align: center;">bool</td>
128
 
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
129
 
          <td style="text-align: center;">False</td>
130
 
        </tr>
131
 
      </table>
132
 
    </div>
133
 
    <h3>Framework-configurable parameters</h3>
134
 
    <div class="table">
135
 
      <table>
136
 
        <tr>
137
 
          <th>Attribute</th>
138
 
          <th style="text-align: center;">Type</th>
139
 
          <th>Description</th>
140
 
          <th style="text-align: center;">Required</th>
141
 
        </tr>
142
 
        <tr>
143
 
          <td valign="top">exename</td>
144
 
          <td style="text-align: center;">string</td>
145
 
          <td> The name of the executable that should be used to launch the external program. </td>
146
 
          <td style="text-align: center;">False</td>
147
 
        </tr>
148
 
        <tr>
149
 
          <td valign="top">managed</td>
150
 
          <td style="text-align: center;">
151
 
            <a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
152
 
          </td>
153
 
          <td> 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. </td>
154
 
          <td style="text-align: center;">False</td>
155
 
        </tr>
156
 
        <tr>
157
 
          <td valign="top">useruntimeengine</td>
158
 
          <td style="text-align: center;">bool</td>
159
 
          <td>
160
 
            <i>Deprecated.</i>  Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
161
 
          <td style="text-align: center;">False</td>
162
 
        </tr>
163
 
      </table>
164
 
    </div>
165
 
    <h3>Nested Elements:</h3>
166
 
    <!--Array-->
167
 
    <!--NestedElementArray=T:NAnt.Core.Types.Argument-->
168
 
    <h4>
169
 
      <a id="arg">
170
 
      </a>
171
 
                    &lt;arg&gt;
172
 
                </h4>
173
 
    <div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><p> When passed to an external application, the argument will be quoted when appropriate. This does not apply to the <code>line</code> parameter, which is always passed as is. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the argument should be passed to the external program. If <b>true</b> then the argument will be passed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><td> The value for a PATH-like command-line argument; you can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the argument should not be passed to the external program. If <b>false</b> then the argument will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
174
 
                    &lt;<a href="../types/path.html">path</a>&gt;
175
 
                </h4><div class="nested-element"> Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div><h4><a id="path"></a>
176
 
                    &lt;/<a href="../types/path.html">path</a>&gt;
177
 
                </h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
178
 
&lt;arg value="-l -a" /&gt;
179
 
    </pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
180
 
&lt;arg line="-l -a" /&gt;
181
 
    </pre></li><li><p> A single command-line argument with the value <code>\dir;\dir2;\dir3</code> on DOS-based systems and <code>/dir:/dir2:/dir3</code> on Unix-like systems. </p><pre class="code">
182
 
&lt;arg path="/dir;/dir2:\dir3" /&gt;
183
 
    </pre></li></ul></div>
184
 
    <h4>
185
 
      <a id="arg">
186
 
      </a>
187
 
                    &lt;/arg&gt;
188
 
                </h4>
189
 
    <h3>Examples</h3>
190
 
    <ul class="examples">
191
 
      <li>
192
 
        <p> Adds all public classes contained in <code>myTest.dll</code> to a COM+ application and produces the <code>myTest.tlb</code> type library. If the application already exists, it is overwritten. </p>
193
 
        <pre class="code">
194
 
            &lt;regsvcs action="FindOrCreate" assembly="myTest.dll" /&gt;
195
 
                </pre>
196
 
      </li>
197
 
      <li>
198
 
        <p> Adds all public classes contained in <code>myTest.dll</code> to <code>myTargetApp</code> and produces the <code>myTest.tlb</code> type library. If the application already exists, it is overwritten. </p>
199
 
        <pre class="code">
200
 
            &lt;regsvcs action="FindOrCreate" assembly="myTest.dll" application="myTargetApp" /&gt;
201
 
                </pre>
202
 
      </li>
203
 
      <li>
204
 
        <p> Adds all public classes contained in <code>myTest.dll</code> to a COM+ application and produces the <code>myTest.tlb</code> type library. A new application is always created. </p>
205
 
        <pre class="code">
206
 
            &lt;regsvcs action="Create" assembly="myTest.dll" /&gt;
207
 
                </pre>
208
 
      </li>
209
 
      <li>
210
 
        <p> Uninstalls the COM+ application contained in <code>myTest.dll</code>. </p>
211
 
        <pre class="code">
212
 
            &lt;regsvcs action="Uninstall" assembly="myTest.dll" /&gt;
213
 
                </pre>
214
 
      </li>
215
 
    </ul>
216
 
    <h3>Requirements</h3>
217
 
    <div style="margin-left: 20px;">
218
 
      <b>Assembly:</b> NAnt.DotNetTasks (0.90.3780.0)
219
 
            </div>
220
 
  </body>
221
 
</html>
 
 
b'\\ No newline at end of file'