PageRenderTime 85ms CodeModel.GetById 40ms app.highlight 10ms RepoModel.GetById 30ms app.codeStats 1ms

/tools/nant/NAnt.MSNetTasks.xml

http://github.com/philiplaureano/LinFu
XML | 579 lines | 579 code | 0 blank | 0 comment | 0 complexity | bdade34fb3b069d67c9409496e2963ae MD5 | raw file
  1<?xml version="1.0"?>
  2<doc>
  3    <assembly>
  4        <name>NAnt.MSNetTasks</name>
  5    </assembly>
  6    <members>
  7        <member name="T:NAnt.MSNet.Tasks.IldasmTask">
  8            <summary>
  9            Disassembles any portable executable (PE) file that contains
 10            intermediate language (IL) code.
 11            </summary>
 12            <remarks>
 13              <para>
 14              Files are only disassembled if the input file is newer than the output
 15              file, or if the output file does not exist.  However, you can 
 16              explicitly force files to be disassembled with the 
 17              <see cref="P:NAnt.MSNet.Tasks.IldasmTask.ForceRebuild"/> attribute.
 18              </para>
 19              <para>
 20              A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to disassemble. 
 21              To use a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.MSNet.Tasks.IldasmTask.ToDirectory"/> 
 22              attribute must be set. The file name of the output file will be equal 
 23              to the file name of the input file, but with extension ".il".
 24              </para>
 25            </remarks>
 26            <example>
 27              <para>
 28              Disassembles <c>helloworld.exe</c> to <c>helloworld.il</c>.
 29              </para>
 30              <code>
 31                <![CDATA[
 32            <ildasm input="helloworld.exe" output="helloworld.il" />
 33                ]]>
 34              </code>
 35            </example>
 36            <example>
 37              <para>
 38              Disassembles a set of PE files into the specified directory.
 39              </para>
 40              <code>
 41                <![CDATA[
 42            <ildasm todir=".">
 43                <assemblies>
 44                    <include name="*.exe" />
 45                    <include name="*.dll" />
 46                </assemblies>
 47            </ildasm>
 48                ]]>
 49              </code>
 50            </example>
 51        </member>
 52        <member name="M:NAnt.MSNet.Tasks.IldasmTask.Initialize">
 53            <summary>
 54            Checks whether the task is initialized with valid attributes.
 55            </summary>
 56        </member>
 57        <member name="M:NAnt.MSNet.Tasks.IldasmTask.ExecuteTask">
 58            <summary>
 59            Disassembles the PE file(s).
 60            </summary>
 61        </member>
 62        <member name="M:NAnt.MSNet.Tasks.IldasmTask.DisassemblyFile(System.IO.FileInfo)">
 63            <summary>
 64            Disassembles the specified PE file.
 65            </summary>
 66            <param name="inputFile">The PE file to disassemble.</param>
 67        </member>
 68        <member name="M:NAnt.MSNet.Tasks.IldasmTask.GetOutputFile(System.IO.FileInfo)">
 69            <summary>
 70            Determines the full path and extension for the output file.
 71            </summary>
 72            <param name="inputFile">
 73            A <see cref="T:System.IO.FileInfo"/> that represents the PE file
 74            file for which the corresponding output file should be determined.
 75            </param>
 76            <returns>
 77            A <see cref="T:System.IO.FileInfo"/> that represents the full path
 78            for the output file.
 79            </returns>
 80            <exception cref="T:NAnt.Core.BuildException">The path of the output file could not be determined.</exception>
 81        </member>
 82        <member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOptions(System.IO.FileInfo,System.IO.FileInfo)">
 83            <summary>
 84            Writes the disassembler options.
 85            </summary>
 86        </member>
 87        <member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOption(System.IO.StringWriter,System.String)">
 88             <summary>
 89             Writes an option using the default output format.
 90             </summary>
 91             <param name="writer">
 92             The <see cref="T:System.IO.StringWriter"/> to which the disassembler options
 93             should be written.
 94            </param>
 95             <param name="name">
 96             A <see cref="T:System.String"/> that contains the name of the
 97             option which should be passed to the disassembler.
 98             </param>
 99        </member>
100        <member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOption(System.IO.StringWriter,System.String,System.String)">
101            <summary>
102            Writes an option and its value using the default output format.
103            </summary>
104            <param name="writer">
105            The <see cref="T:System.IO.StringWriter"/> to which the disassembler options
106            should be written.
107            </param>
108            <param name="name">
109            A <see cref="T:System.String"/> that contains the name of the
110            option which should be passed to the disassembler.
111            </param>
112            <param name="arg">
113            A <see cref="T:System.String"/> that contains the value of the
114            option which should be passed to the disassembler.
115            </param>
116        </member>
117        <member name="M:NAnt.MSNet.Tasks.IldasmTask.NeedsDisassembling(System.IO.FileInfo,System.IO.FileInfo)">
118            <summary>
119            Determines whether or not disassembling is needed.
120            </summary>
121            <returns>
122            <see langword="true" /> if disassembling is needed; otherwise,
123            <see langword="false" />.
124            </returns>
125        </member>
126        <member name="P:NAnt.MSNet.Tasks.IldasmTask.All">
127            <summary>
128            Specifies whether or not the disassembler should combine the
129            <c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options. The default 
130            is <see langword="false" />.
131            </summary>
132            <value>
133            <see langword="true" /> if the disassembler should combine the
134            <c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options;
135            otherwise, <see langword="false" />. The default is
136            <see langword="false" />.
137            </value>
138            <remarks>
139            <para>
140            Corresponds to the <c>/ALL</c> flag.
141            </para>
142            </remarks>
143        </member>
144        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Bytes">
145            <summary>
146            Specifies whether or not the disassembler should generate the
147            IL stream bytes (in hexadecimal notation) as instruction comments.
148            The default is <see langword="false" />.
149            </summary>
150            <value>
151            <see langword="true" /> if the IL stream bytes should be generated
152            as instruction comments; otherwise, <see langword="false" />. The
153            default is <see langword="false" />.
154            </value>
155            <remarks>
156            <para>
157            Corresponds to the <c>/BYTE</c> flag.
158            </para>
159            </remarks>
160        </member>
161        <member name="P:NAnt.MSNet.Tasks.IldasmTask.ForceRebuild">
162            <summary>
163            Instructs NAnt to rebuild the output file regardless of the file
164            timestamps. The default is <see langword="false" />.
165            </summary>
166            <value>
167            <see langword="true" /> if the output file should be rebuilt
168            regardless of its timestamps; otherwise <see langword="false" />.
169            The default is <see langword="false" />.
170            </value>
171        </member>
172        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Header">
173            <summary>
174            Specifies whether or not the disassembler should include PE header
175            information and runtime header information in the output. The default 
176            is <see langword="false" />.
177            </summary>
178            <value>
179            <see langword="true" /> if PE header information and runtime header
180            information should be included in the output; otherwise,
181            <see langword="false" />. The default is <see langword="false" />.
182            </value>
183            <remarks>
184            <para>
185            Corresponds to the <c>/HEADER</c> flag.
186            </para>
187            </remarks>
188        </member>
189        <member name="P:NAnt.MSNet.Tasks.IldasmTask.InputFile">
190            <summary>
191            Specifies the PE file to disassemble.
192            </summary>
193            <value>
194            A <see cref="T:System.IO.FileInfo"/> that represents the PE file
195            to disassemble.
196            </value>
197        </member>
198        <member name="P:NAnt.MSNet.Tasks.IldasmTask.LineNumbers">
199            <summary>
200            Specifies whether or not the disassembler should include
201            references to original source lines. The default is <see langword="false" />.
202            </summary>
203            <value>
204            <see langword="true" /> if references to original source lines
205            should be included; otherwise, <see langword="false" />. The
206            default is <see langword="false" />.
207            </value>
208            <remarks>
209            <para>
210            Corresponds to the <c>/LINENUM</c> flag.
211            </para>
212            </remarks>
213        </member>
214        <member name="P:NAnt.MSNet.Tasks.IldasmTask.NoIL">
215            <summary>
216            Specifies whether or not the disassembler should suppress ILASM
217            code output. The default is <see langword="false" />.
218            </summary>
219            <value>
220            <see langword="true" /> if ILASM code output should be suppresses;
221            otherwise, <see langword="false" />. The default is
222            <see langword="false" />.
223            </value>
224            <remarks>
225            <para>
226            Corresponds to the <c>/NOIL</c> flag.
227            </para>
228            </remarks>
229        </member>
230        <member name="P:NAnt.MSNet.Tasks.IldasmTask.PublicOnly">
231            <summary>
232            Specifies whether or not the disassembler should disassemble
233            public items only. This is a shortcut for <see cref="P:NAnt.MSNet.Tasks.IldasmTask.Visibility"/>="pub".
234            The default is <see langword="false"/>.
235            </summary>
236            <value>
237            <see langword="true"/> if only public items should be
238            disassembled; otherwise, <see langword="false"/>. The default is
239            <see langword="false"/>.
240            </value>
241            <remarks>
242            <para>
243            Corresponds to the <c>/PUBONLY</c> flag.
244            </para>
245            </remarks>
246        </member>
247        <member name="P:NAnt.MSNet.Tasks.IldasmTask.QuoteAllNames">
248            <summary>
249            Specifies whether or not the disassembler should enclose all names
250            in single quotation marks. By default, only names that don't match
251            the ILASM definition of a simple name are quoted. The default is 
252            <see langword="false" />.
253            </summary>
254            <value>
255            <see langword="true" /> if all names should be enclosed in single
256            quotation marks; otherwise, <see langword="false" />. The default
257            is <see langword="false" />.
258            </value>
259            <remarks>
260            <para>
261            Corresponds to the <c>/QUOTEALLNAMES</c> flag.
262            </para>
263            </remarks>
264        </member>
265        <member name="P:NAnt.MSNet.Tasks.IldasmTask.RawExceptionHandling">
266            <summary>
267            Specifies whether or not the disassembler should generate
268            structured exception handling clauses in canonical (label) form.
269            The default is <see langword="false" />.
270            </summary>
271            <value>
272            <see langword="true" /> if structured exception handling clauses
273            should be generated in canonical form; otherwise,
274            <see langword="false" />. The default is <see langword="false" />.
275            </value>
276            <remarks>
277            <para>
278            Corresponds to the <c>/RAWEH</c> flag.
279            </para>
280            </remarks>
281        </member>
282        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Source">
283            <summary>
284            Specifies whether or not the disassembler should generate
285            original source lines as comments. The default is <see langword="false" />.
286            </summary>
287            <value>
288            <see langword="true" /> if original source lines should be
289            generated as comments; otherwise, <see langword="false" />.
290            The default is <see langword="false" />.
291            </value>
292            <remarks>
293            <para>
294            Corresponds to the <c>/SOURCE</c> flag.
295            </para>
296            </remarks>
297        </member>
298        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Tokens">
299            <summary>
300            Specifies whether or not the disassembler should generate metadata
301            token values as comments. The default is <see langword="false" />.
302            </summary>
303            <value>
304            <see langword="true" /> if metadata token values should be
305            generated as comments; otherwise, <see langword="false" />. The
306            default is <see langword="false" />.
307            </value>
308            <remarks>
309            <para>
310            Corresponds to the <c>/TOKENS</c> flag.
311            </para>
312            </remarks>
313        </member>
314        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Unicode">
315            <summary>
316            Specifies whether or not the disassembler should use the UNICODE
317            encoding when generating the output. The default is ANSI.
318            </summary>
319            <value>
320            <see langword="true" /> if the output should be generated using
321            the UNICODE encoding; otherwise, <see langword="false" />. The
322            default is <see langword="false" />.
323            </value>
324            <remarks>
325            <para>
326            Corresponds to the <c>/UNICODE</c> flag.
327            </para>
328            </remarks>
329        </member>
330        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Utf8">
331            <summary>
332            Specifies whether or not the disassembler should use the UTF-8
333            encoding when generating the output. The default is ANSI.
334            </summary>
335            <value>
336            <see langword="true" /> if the output should be generated using
337            the UTF-8 encoding; otherwise, <see langword="false" />. The
338            default is <see langword="false" />.
339            </value>
340            <remarks>
341            <para>
342            Corresponds to the <c>/UTF8</c> flag.
343            </para>
344            </remarks>
345        </member>
346        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Item">
347            <summary>
348            Instructs the disassembler to disassemble the specified item only.
349            </summary>
350            <value>
351            A <see cref="T:System.String"/> that specifies the item to
352            disassemble.
353            </value>
354            <remarks>
355            <para>
356            Corresponds to the <c>/ITEM</c> flag.
357            </para>
358            </remarks>
359        </member>
360        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Visibility">
361            <summary>
362            Instructs the disassembler to disassemble only the items with the
363            specified visibility. Possible values are <c>PUB</c>, <c>PRI</c>,
364            <c>FAM</c>, <c>ASM</c>, <c>FAA</c>, <c>FOA</c>, <c>PSC</c>,
365            or any combination of them separated by <c>+</c>.
366            </summary>
367            <value>
368            A <see cref="T:System.String"/> that contains the visibility
369            suboptions.
370            </value>
371            <remarks>
372            <para>
373            Corresponds to the <c>/VISIBILITY</c> flag.
374            </para>
375            </remarks>
376        </member>
377        <member name="P:NAnt.MSNet.Tasks.IldasmTask.OutputFile">
378            <summary>
379            Specifies the name of the output file created by the disassembler.
380            </summary>
381            <value>
382            A <see cref="T:System.IO.FileInfo"/> that represents the name of
383            the output file.
384            </value>
385            <remarks>
386            <para>
387            Corresponds to the <c>/OUT</c> flag.
388            </para>
389            </remarks>
390        </member>
391        <member name="P:NAnt.MSNet.Tasks.IldasmTask.ToDirectory">
392            <summary>
393            Specifies the directory to which outputs will be stored.
394            </summary>
395            <value>
396            A <see cref="T:System.IO.DirectoryInfo"/> that represents the
397            directory to which outputs will be stored.
398            </value>
399        </member>
400        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Assemblies">
401            <summary>
402            Specifies a list of PE files to disassemble. To use a <see cref="T:NAnt.Core.Types.FileSet"/>, 
403            the <see cref="P:NAnt.MSNet.Tasks.IldasmTask.ToDirectory"/> attribute must be specified.
404            </summary>
405            <value>
406            A <see cref="T:NAnt.Core.Types.FileSet"/> that represents the set
407            of PE files to disassemble.
408            </value>
409        </member>
410        <member name="P:NAnt.MSNet.Tasks.IldasmTask.Arguments">
411            <summary>
412            The command-line arguments for the external program.
413            </summary>
414            <remarks>
415            Overridden to ensure the &lt;arg&gt; elements would not be exposed
416            to build authors.
417            </remarks>
418        </member>
419        <member name="P:NAnt.MSNet.Tasks.IldasmTask.ProgramArguments">
420            <summary>
421            Gets the command-line arguments for the external program.
422            </summary>
423            <value>
424            A <see cref="T:System.String"/> that contains the command-line
425            arguments for the external program.
426            </value>
427        </member>
428        <member name="T:NAnt.MSNet.Tasks.ServiceControllerTask">
429            <summary>
430            Allows a Windows service to be controlled.
431            </summary>
432            <example>
433              <para>Starts the World Wide Web Publishing Service on the local computer.</para>
434              <code>
435                <![CDATA[
436            <servicecontroller action="Start" service="w3svc" />
437                ]]>
438              </code>
439            </example>
440            <example>
441              <para>Stops the Alerter service on computer 'MOTHER'.</para>
442              <code>
443                <![CDATA[
444            <servicecontroller action="Stop" service="Alerter" machine="MOTHER" />
445                ]]>
446              </code>
447            </example>
448        </member>
449        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.#ctor">
450            <summary>
451            Initializes a new instance of the <see cref="T:NAnt.MSNet.Tasks.ServiceControllerTask"/>
452            class.
453            </summary>
454        </member>
455        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.ExecuteTask">
456            <summary>
457            Peforms actions on the service in order to reach the desired status.
458            </summary>
459        </member>
460        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.DetermineDesiredStatus">
461            <summary>
462            Determines the desired status of the service based on the action
463            that should be performed on it.
464            </summary>
465            <returns>
466            The <see cref="T:System.ServiceProcess.ServiceControllerStatus"/> that should be reached
467            in order for the <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.Action"/> to be considered successful.
468            </returns>
469        </member>
470        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.StartService(System.ServiceProcess.ServiceController)">
471            <summary>
472            Starts the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
473            <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
474            </summary>
475            <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
476        </member>
477        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.StopService(System.ServiceProcess.ServiceController)">
478            <summary>
479            Stops the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
480            <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
481            </summary>
482            <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
483        </member>
484        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.RestartService(System.ServiceProcess.ServiceController)">
485            <summary>
486            Restarts the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
487            <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
488            </summary>
489            <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
490        </member>
491        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.PauseService(System.ServiceProcess.ServiceController)">
492            <summary>
493            Pauses the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
494            <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
495            </summary>
496            <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
497        </member>
498        <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.ContinueService(System.ServiceProcess.ServiceController)">
499            <summary>
500            Continues the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
501            <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
502            </summary>
503            <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
504        </member>
505        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._serviceName">
506            <summary>
507            Holds the name of the service that should be controlled.
508            </summary>
509        </member>
510        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._machineName">
511            <summary>
512            Holds the name of the computer on which the service resides.
513            </summary>
514        </member>
515        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._action">
516            <summary>
517            Holds the action that should be performed on the service.
518            </summary>
519        </member>
520        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._timeout">
521            <summary>
522            Holds the time, in milliseconds, the task will wait for a service
523            to reach the desired status.
524            </summary>
525        </member>
526        <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName">
527            <summary>
528            The name of the service that should be controlled.
529            </summary>
530        </member>
531        <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName">
532            <summary>
533            The name of the computer on which the service resides. The default
534            is the local computer.
535            </summary>
536        </member>
537        <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.Action">
538            <summary>
539            The action that should be performed on the service.
540            </summary>
541        </member>
542        <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.Timeout">
543            <summary>
544            The time, in milliseconds, the task will wait for the service to
545            reach the desired status. The default is 5000 milliseconds.
546            </summary>
547        </member>
548        <member name="T:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType">
549            <summary>
550            Defines the actions that can be performed on a service.
551            </summary>
552        </member>
553        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Start">
554            <summary>
555            Starts a service.
556            </summary>
557        </member>
558        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Stop">
559            <summary>
560            Stops a service.
561            </summary>
562        </member>
563        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Restart">
564            <summary>
565            Restarts a service.
566            </summary>
567        </member>
568        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Pause">
569            <summary>
570            Pauses a running service.
571            </summary>
572        </member>
573        <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Continue">
574            <summary>
575            Continues a paused service.
576            </summary>
577        </member>
578    </members>
579</doc>