[castle.git] / Experiments / Generator / Generators / Project / Templates / lib / nant / NAnt.Contrib.Tasks.xml
| blob | 3bb25c6d689e5b4f39e73b06faab6ba0e3659117 |
1 <?xml version="1.0"?>\r
2 <doc>\r
3 <assembly>\r
4 <name>NAnt.Contrib.Tasks</name>\r
5 </assembly>\r
6 <members>\r
7 <member name="T:NAnt.Contrib.Tasks.Grep.GrepTask">\r
8 <summary>\r
9 Searches files for a regular-expression and produces an XML report of \r
10 the matches.\r
11 </summary>\r
12 <example>\r
13 <para>\r
14 Extract all <i>TODO:</i>, <i>UNDONE:</i> or <i>HACK:</i>-\r
15 comment-tags from C# source files and write them to a file\r
16 <i>out.xml</i>. (A xslt-stylesheet could then transform it to\r
17 a nice html-page for your project-homepage, but that is beyond\r
18 the scope of this example.) \r
19 </para>\r
20 <para>\r
21 <i>Path</i>, <i>File</i> and <i>LineNumber</i> are automatically\r
22 generated elements.\r
23 </para>\r
24 <code>\r
25 <![CDATA[\r
26 <grep output="out.xml" pattern="// (?'Type'TODO|UNDONE|HACK): (\[(?'Author'\w*),(?'Date'.*)\])? (?'Text'[^\n\r]*)">\r
27 <fileset>\r
28 <include name="*.cs" />\r
29 </fileset>\r
30 </grep>\r
31 ]]>\r
32 </code>\r
33 <para>\r
34 The resulting XML file for a comment-tag \r
35 'TODO: [md, 14-02-2004] comment this method'\r
36 will look like\r
37 </para>\r
38 <code>\r
39 <![CDATA[\r
40 <?xml version="1.0" encoding="utf-8" ?> \r
41 <Matches>\r
42 <Match>\r
43 <Type>TODO</Type> \r
44 <Text>comment this method</Text> \r
45 <Path>C:\MyProjects\MyPath</Path>\r
46 <File>MyFile.cs</Filename> \r
47 <LineNumber>146</LineNumber> \r
48 <Author>md</Author>\r
49 <Date>14-02-2004</Date>\r
50 </Match>\r
51 ...\r
52 </Matches>\r
53 ]]>\r
54 </code> \r
55 </example>\r
56 </member>\r
57 <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.ExecuteTask">\r
58 <summary>\r
59 Performs the regex-search.\r
60 </summary>\r
61 </member>\r
62 <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteXml(NAnt.Contrib.Tasks.Grep.MatchCollection,System.IO.StreamWriter)">\r
63 <summary>\r
64 Writes the collection of matches to the specified <see cref="T:System.IO.StreamWriter"/>\r
65 in XML format.\r
66 </summary>\r
67 <param name="matches">The matches to write.</param>\r
68 <param name="writer"><see cref="T:System.IO.StreamWriter"/> to write the matches to.</param>\r
69 </member>\r
70 <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteMatches(NAnt.Contrib.Tasks.Grep.MatchCollection)">\r
71 <summary>\r
72 Writes the specified matches to <see cref="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile"/>.\r
73 </summary>\r
74 <param name="matches">The collection of matches to write.</param>\r
75 </member>\r
76 <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile">\r
77 <summary>\r
78 Specifies the name of the output file.\r
79 </summary>\r
80 </member>\r
81 <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.Pattern">\r
82 <summary>\r
83 Specifies the regular-expression to search for.\r
84 </summary>\r
85 </member>\r
86 <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.InputFiles">\r
87 <summary>\r
88 The set of files in which the expression is searched.\r
89 </summary>\r
90 </member>\r
91 <member name="T:NAnt.Contrib.Tasks.Grep.LineCounter">\r
92 <summary>\r
93 This purpose of this class is to get the line-numbers within \r
94 a string for a specific position of a character \r
95 (an index, as returned by the <see cref="T:System.Text.RegularExpressions.Regex"/> class).\r
96 </summary>\r
97 </member>\r
98 <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._string">\r
99 <summary>\r
100 The string to count in\r
101 </summary>\r
102 </member>\r
103 <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos">\r
104 <summary>\r
105 The current position within <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._string"/>.\r
106 </summary>\r
107 </member>\r
108 <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentLine">\r
109 <summary>\r
110 The number of line feeds upto (but exluding) <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos"/>.\r
111 </summary>\r
112 </member>\r
113 <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.#ctor(System.String)">\r
114 <summary>\r
115 Constructs a line-counter for a <see cref="T:System.String"/>.\r
116 </summary>\r
117 <param name="str"><see cref="T:System.String"/> for which lines are counted.</param>\r
118 </member>\r
119 <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.CountTo(System.Int32)">\r
120 <summary>\r
121 Counts the line-numbers until the position <paramref name="pos" />\r
122 is reached.\r
123 </summary>\r
124 <param name="pos">Index into the string given during construction </param>\r
125 <returns>\r
126 The number of lines.\r
127 </returns>\r
128 </member>\r
129 <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.Count(System.String,System.Char,System.Int32,System.Int32)">\r
130 <summary>\r
131 Counts the number of occurences of <paramref name="c"/> in the \r
132 range from <paramref name="start"/> to <paramref name="end"/> in \r
133 string <paramref name="str"/>.\r
134 </summary>\r
135 <param name="str"><see cref="T:System.String"/> to count in.</param>\r
136 <param name="c">Character to count.</param>\r
137 <param name="start">Start of range.</param>\r
138 <param name="end">End of range.</param>\r
139 <returns>\r
140 The number of occurences of <paramref name="c"/> in the range from \r
141 <paramref name="start"/> to <paramref name="end"/> in string \r
142 <paramref name="str"/>.\r
143 </returns>\r
144 </member>\r
145 <member name="T:NAnt.Contrib.Tasks.Grep.Match">\r
146 <summary>\r
147 Encapsulation of a match of a regular-expression with the\r
148 associated named capture-groups.\r
149 </summary>\r
150 </member>\r
151 <member name="F:NAnt.Contrib.Tasks.Grep.Match.values">\r
152 <summary>\r
153 <see cref="T:System.Collections.Hashtable"/> containing the mapping from group names \r
154 to values.\r
155 </summary>\r
156 </member>\r
157 <member name="M:NAnt.Contrib.Tasks.Grep.Match.WriteXml(System.Xml.XmlTextWriter)">\r
158 <summary>\r
159 Writes this match to an <see cref="T:System.Xml.XmlTextWriter"/>.\r
160 </summary>\r
161 <param name="xmlWriter">The <see cref="T:System.Xml.XmlTextWriter"/> to write to.</param>\r
162 </member>\r
163 <member name="P:NAnt.Contrib.Tasks.Grep.Match.Item(System.String)">\r
164 <summary>\r
165 Gets or sets the value for a capture group.\r
166 </summary>\r
167 </member>\r
168 <member name="T:NAnt.Contrib.Tasks.Grep.MatchCollection">\r
169 <summary>\r
170 A strongly-typed collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances.\r
171 </summary>\r
172 </member>\r
173 <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.Match)">\r
174 <summary>\r
175 Adds a <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to this collection.\r
176 </summary>\r
177 <param name="match"><see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to add.</param>\r
178 </member>\r
179 <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.MatchCollection)">\r
180 <summary>\r
181 Adds all <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances <paramref name="matches"/>\r
182 to this collection.\r
183 </summary>\r
184 <param name="matches">Collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances to add.</param>\r
185 </member>\r
186 <member name="P:NAnt.Contrib.Tasks.Grep.MatchCollection.Item(System.Int32)">\r
187 <summary>\r
188 Gets the <paramref name="idx" />th match stored in this collection.\r
189 </summary>\r
190 </member>\r
191 <member name="T:NAnt.Contrib.Tasks.Grep.Pattern">\r
192 <summary>\r
193 Encapsulation of a search pattern.\r
194 </summary>\r
195 </member>\r
196 <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.#ctor(System.String)">\r
197 <summary>\r
198 Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.Grep.Pattern"/> class from \r
199 a regular-expression.\r
200 </summary>\r
201 <param name="regex">The regular-expression.</param>\r
202 </member>\r
203 <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.ConcatenateCaptures(System.Text.RegularExpressions.Group)">\r
204 <summary>\r
205 Concatenates the captures of <paramref name="group"/> to a string.\r
206 </summary>\r
207 <param name="group"><see cref="T:System.Text.RegularExpressions.Group"/> containing the captures.</param>\r
208 <returns>\r
209 <see cref="T:System.String"/> containg the concatenated captures.\r
210 </returns>\r
211 <remarks>\r
212 A named-group can captured multiple times, when the regular\r
213 expression has a quantifier, e.g. (// (?'Text'.*) )* will match\r
214 multiline comments with group <i>Text</i> having a capture for\r
215 every line.\r
216 </remarks>\r
217 </member>\r
218 <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.Extract(System.String,System.String)">\r
219 <summary>\r
220 Extracts the matches of this pattern from <paramref name="source" />.\r
221 </summary>\r
222 <param name="filename">The name of the file associated with <paramref name="source" />.</param>\r
223 <param name="source">The source string</param>\r
224 <returns>\r
225 A collection of found matches.\r
226 </returns>\r
227 </member>\r
228 <member name="T:NAnt.Contrib.Tasks.Mks.BaseTask">\r
229 <summary>\r
230 The base abstract class for all MKS Tasks. \r
231 </summary>\r
232 <remarks>\r
233 Provides the core attributes, and functionality for opening an item \r
234 in a MKS database.\r
235 </remarks>\r
236 </member>\r
237 <member name="M:NAnt.Contrib.Tasks.Mks.BaseTask.Open">\r
238 <summary>\r
239 Opens the MKS database and sets the reference to the specified\r
240 item and version.\r
241 </summary>\r
242 </member>\r
243 <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Password">\r
244 <summary>\r
245 The password to use to login to the MKS database.\r
246 </summary>\r
247 </member>\r
248 <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.UserName">\r
249 <summary>\r
250 The name of the user needed to access the MKS database.\r
251 </summary>\r
252 </member>\r
253 <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Host">\r
254 <summary>\r
255 The name of the host MKS server to connect to\r
256 </summary>\r
257 </member>\r
258 <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Port">\r
259 <summary>\r
260 The port number on which the host server is accepting requests\r
261 </summary>\r
262 </member>\r
263 <member name="T:NAnt.Contrib.Tasks.Mks.CheckpointTask">\r
264 <summary>\r
265 Checkpoints a project in an MKS Source Integrity database.\r
266 </summary>\r
267 <example>\r
268 <para>Checkpoint a project in an MKS database.</para>\r
269 <code><![CDATA[\r
270 <mkscheckpoint\r
271 username="myusername"\r
272 password="mypassword"\r
273 host="servername"\r
274 port="123"\r
275 project="myproject"\r
276 recursive="false"\r
277 label="test from nant"\r
278 description="this is a test description"\r
279 />\r
280 ]]></code>\r
281 </example>\r
282 </member>\r
283 <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Label">\r
284 <summary>\r
285 The label to apply to the checkpoint.\r
286 </summary>\r
287 </member>\r
288 <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.ProjectName">\r
289 <summary>\r
290 The project to checkpoint.\r
291 </summary>\r
292 </member>\r
293 <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Recursive">\r
294 <summary>\r
295 Apply label to all members. The default is <see langword="false" />.\r
296 </summary>\r
297 </member>\r
298 <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Description">\r
299 <summary>\r
300 The description of the checkpoint.\r
301 </summary>\r
302 </member>\r
303 <member name="T:NAnt.Contrib.Tasks.Mks.GetTask">\r
304 <summary>\r
305 Retrieves an item or project from MKS Source Integrity.\r
306 </summary>\r
307 <example>\r
308 <para>Synchronise sandbox with MKS project.</para>\r
309 <code><![CDATA[\r
310 <mksget\r
311 username="myusername"\r
312 password="mypassword"\r
313 host="servername"\r
314 port="123"\r
315 localpath="c:\sourcecode"\r
316 project="e:/MKS projects/myproject/testproject.pj"\r
317 />\r
318 ]]></code>\r
319 </example>\r
320 </member>\r
321 <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.LocalPath">\r
322 <summary>\r
323 The path to the local working directory.\r
324 </summary>\r
325 </member>\r
326 <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.ProjectName">\r
327 <summary>\r
328 The project to get from MKS.\r
329 </summary>\r
330 </member>\r
331 <member name="T:NAnt.Contrib.Tasks.Mks.ChangesTask">\r
332 <summary>\r
333 Generates an XML file containing the differences between the sandbox and\r
334 the project in the MKS database.\r
335 </summary>\r
336 <example>\r
337 <para>Get changes to a project in an MKS database.</para>\r
338 <code><![CDATA[\r
339 <mkschanges\r
340 username="myusername"\r
341 password="mypassword"\r
342 host="servername"\r
343 port="123"\r
344 sandbox="mysandbox.pj"\r
345 output="mychanges.xml"\r
346 />\r
347 ]]></code>\r
348 </example>\r
349 </member>\r
350 <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.Sandbox">\r
351 <summary>\r
352 The project to retrieve the changes for.\r
353 </summary>\r
354 </member>\r
355 <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.OutputFile">\r
356 <summary>\r
357 The file where the output will be stored in XML format.\r
358 </summary>\r
359 </member>\r
360 <member name="T:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand">\r
361 <summary>\r
362 Base class for <see cref="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand"/> and <see cref="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand"/>.\r
363 </summary>\r
364 </member>\r
365 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.IsVersion(System.String@)">\r
366 <summary>\r
367 Determines if the supplied version string is valid. A valid version string should look like:\r
368 1\r
369 1.1\r
370 1.1.1\r
371 1.1.1.1\r
372 </summary>\r
373 <param name="Version">The version string to verify.</param>\r
374 <returns></returns>\r
375 </member>\r
376 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ReorderFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">\r
377 <summary>\r
378 Sets the sequence number of files to match their\r
379 storage order in the cabinet file, after some\r
380 files have had their filenames changed to go in\r
381 their own component.\r
382 </summary>\r
383 <param name="database">The MSI database.</param>\r
384 <param name="LastSequence">The last file's sequence number.</param>\r
385 </member>\r
386 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CleanOutput(System.String,System.String)">\r
387 <summary>\r
388 Cleans the output directory after a build.\r
389 </summary>\r
390 <param name="cabFile">The path to the cabinet file.</param>\r
391 <param name="tempPath">The path to temporary files.</param>\r
392 </member>\r
393 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
394 <summary>\r
395 Loads records for the Properties table.\r
396 </summary>\r
397 <param name="database">The MSI database.</param>\r
398 </member>\r
399 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirectories(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
400 <summary>\r
401 Loads records for the Directories table.\r
402 </summary>\r
403 <param name="database">The MSI database.</param>\r
404 </member>\r
405 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddDirectory(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Schemas.Msi.MSIDirectory,System.Int32)">\r
406 <summary>\r
407 Adds a directory record to the directories table.\r
408 </summary>\r
409 <param name="database">The MSI database.</param>\r
410 <param name="directoryTable">The MSI database view.</param>\r
411 <param name="ParentDirectory">The parent directory.</param>\r
412 <param name="Directory">This directory's Schema object.</param>\r
413 <param name="Depth">The tree depth of this directory.</param>\r
414 </member>\r
415 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRelativePath(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.String,System.String,System.Text.StringBuilder,NAnt.Contrib.Tasks.Msi.InstallerTable)">\r
416 <summary>\r
417 Retrieves the relative path of a file based on\r
418 the component it belongs to and its entry in\r
419 the MSI directory table.\r
420 </summary>\r
421 <param name="database">The MSI database.</param>\r
422 <param name="Name">The Name of the Folder</param>\r
423 <param name="Parent">The Parent of the Folder</param>\r
424 <param name="Default">The Relative Filesystem Path of the Folder</param>\r
425 <param name="Path">The Path to the Folder from previous calls.</param>\r
426 <param name="directoryTable">The MSI database view.</param>\r
427 </member>\r
428 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetDisplayablePath(System.String)">\r
429 <summary>\r
430 If the specified path is longer than 40 characters, 37 are returned plus ...\r
431 </summary>\r
432 <param name="path">A shortened path</param>\r
433 <returns></returns>\r
434 </member>\r
435 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortFile(System.String)">\r
436 <summary>\r
437 Retrieves a DOS 8.3 filename for a file.\r
438 </summary>\r
439 <param name="LongFile">The file to shorten.</param>\r
440 <returns>The new shortened file.</returns>\r
441 </member>\r
442 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortPath(System.String)">\r
443 <summary>\r
444 Retrieves a DOS 8.3 filename for a directory.\r
445 </summary>\r
446 <param name="LongPath">The path to shorten.</param>\r
447 <returns>The new shortened path.</returns>\r
448 </member>\r
449 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortDir(System.String)">\r
450 <summary>\r
451 Retrieves a DOS 8.3 filename for a complete directory.\r
452 </summary>\r
453 <param name="LongPath">The path to shorten.</param>\r
454 <returns>The new shortened path.</returns>\r
455 </member>\r
456 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">\r
457 <summary>\r
458 Recursively expands properties of all attributes of\r
459 a nodelist and their children.\r
460 </summary>\r
461 <param name="Nodes">The nodes to recurse.</param>\r
462 </member>\r
463 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ByteArrayToString(System.Byte[])">\r
464 <summary>\r
465 Converts the Byte array in a public key\r
466 token of an assembly to a string MSI expects.\r
467 </summary>\r
468 <param name="ByteArray">The array of bytes.</param>\r
469 <returns>The string containing the array.</returns>\r
470 </member>\r
471 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadTypeLibs(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
472 <summary>\r
473 Loads TypeLibs for the TypeLib table.\r
474 </summary>\r
475 <param name="database">The MSI database.</param>\r
476 </member>\r
477 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadEnvironmentVariables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
478 <summary>\r
479 Loads environment variables for the Environment table.\r
480 </summary>\r
481 <param name="database">The MSI database.</param>\r
482 </member>\r
483 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistry(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
484 <summary>\r
485 Loads records for the Registry table.\r
486 </summary>\r
487 <param name="database">The MSI database.</param>\r
488 </member>\r
489 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistryLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
490 <summary>\r
491 Loads records for the RegLocator table\r
492 </summary>\r
493 <param name="database">The MSI database.</param>\r
494 </member>\r
495 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
496 <summary>\r
497 Loads records for the CompLocator table\r
498 </summary>\r
499 <param name="database">The MSI database.</param>\r
500 </member>\r
501 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIniLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
502 <summary>\r
503 Loads records for the IniLocator table\r
504 </summary>\r
505 <param name="database">The MSI database.</param>\r
506 </member>\r
507 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirFileLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
508 <summary>\r
509 Loads records for the DrLocator table\r
510 </summary>\r
511 <param name="database">The MSI database.</param>\r
512 </member>\r
513 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDepreciatedLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
514 <summary>\r
515 Loads records for the RegLocator table\r
516 </summary>\r
517 <param name="database">The MSI database.</param>\r
518 </member>\r
519 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRegistryRootByName(System.String)">\r
520 <summary>\r
521 Gets the name of the registry root id by it's name.\r
522 </summary>\r
523 <param name="root">Name of the registry root</param>\r
524 <returns></returns>\r
525 </member>\r
526 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadApplicationSearch(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
527 <summary>\r
528 Loads records for the AppSearch table\r
529 </summary>\r
530 <param name="database">The MSI database.</param>\r
531 </member>\r
532 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIconData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
533 <summary>\r
534 Loads records for the Icon table.\r
535 </summary>\r
536 <param name="database">The MSI database.</param>\r
537 </member>\r
538 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadShortcutData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
539 <summary>\r
540 Loads records for the Shortcut table.\r
541 </summary>\r
542 <param name="database">The MSI database.</param>\r
543 </member>\r
544 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUserDefinedTables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
545 <summary>\r
546 Adds custom table(s) to the msi database\r
547 </summary>\r
548 <param name="database">The MSI database.</param>\r
549 </member>\r
550 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddTableData(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,NAnt.Contrib.Schemas.Msi.MSITable,System.Collections.ArrayList)">\r
551 <summary>\r
552 Adds table data to the msi database table structure\r
553 </summary>\r
554 <param name="database">The MSI database.</param>\r
555 <param name="currentTable">The current table name</param>\r
556 <param name="xmlTable">Xml node representing the current table</param>\r
557 <param name="columnList">List of column objects for the current table (Containing: column name, id, type).</param>\r
558 </member>\r
559 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadBinaryData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
560 <summary>\r
561 Loads records for the Binary table. This table stores items\r
562 such as bitmaps, animations, and icons. The binary table is\r
563 also used to store data for custom actions.\r
564 </summary>\r
565 <param name="database">The MSI database.</param>\r
566 </member>\r
567 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
568 <summary>\r
569 Loads records for the Dialog table.\r
570 </summary>\r
571 <param name="database">The MSI database.</param>\r
572 </member>\r
573 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
574 <summary>\r
575 Loads records for the Control table.\r
576 </summary>\r
577 <param name="database">The MSI database.</param>\r
578 </member>\r
579 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlConditionData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
580 <summary>\r
581 Loads records for the ControlCondtion table.\r
582 </summary>\r
583 <param name="database">The MSI database.</param>\r
584 </member>\r
585 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlEventData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
586 <summary>\r
587 Loads records for the ControlEvent table.\r
588 </summary>\r
589 <param name="database">The MSI database.</param>\r
590 </member>\r
591 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadCustomAction(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
592 <summary>\r
593 Loads records for the CustomAction table\r
594 </summary>\r
595 <param name="database">The MSI database.</param>\r
596 </member>\r
597 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadActionText(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
598 <summary>\r
599 Loads records for the ActionText table. Allows users to specify descriptions/templates for actions.\r
600 </summary>\r
601 <param name="database">The MSI database.</param>\r
602 </member>\r
603 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppMappings(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
604 <summary>\r
605 Loads records for the _AppMappings table.\r
606 </summary>\r
607 <param name="database">The MSI database.</param>\r
608 </member>\r
609 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUrlProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
610 <summary>\r
611 Loads records for the _UrlToDir table.\r
612 "Load the url properties to convert\r
613 url properties to a properties object" ??\r
614 </summary>\r
615 <param name="database">The MSI database.</param>\r
616 </member>\r
617 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadVDirProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
618 <summary>\r
619 Loads records for the _VDirToUrl table.\r
620 Used for converting a vdir to an url\r
621 </summary>\r
622 <param name="database">The MSI database.</param>\r
623 </member>\r
624 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppRootCreate(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
625 <summary>\r
626 Loads records for the _AppRootCreate table.\r
627 Used for making a virtual directory a virtual application\r
628 </summary>\r
629 <param name="database">The MSI database.</param>\r
630 </member>\r
631 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIISDirectoryProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
632 <summary>\r
633 Loads records for the _IISProperties table.\r
634 </summary>\r
635 <param name="database">The MSI database.</param>\r
636 </member>\r
637 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CheckAssemblyForCOMInterop(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.Reflection.Assembly,System.String,System.String,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">\r
638 <summary>\r
639 Enumerates the registry to see if an assembly has been registered\r
640 for COM interop, and if so adds these registry keys to the Registry\r
641 table, ProgIds to the ProgId table, classes to the Classes table,\r
642 and a TypeLib to the TypeLib table.\r
643 </summary>\r
644 <param name="database">The MSI database.</param>\r
645 <param name="fileName">The Assembly filename.</param>\r
646 <param name="fileAssembly">The Assembly to check.</param>\r
647 <param name="componentName">The name of the containing component.</param>\r
648 <param name="assemblyComponentName">The name of the containing component's assembly GUID.</param>\r
649 <param name="classTable">View containing the Class table.</param>\r
650 <param name="progIdTable">View containing the ProgId table.</param>\r
651 </member>\r
652 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSummaryInformation(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
653 <summary>\r
654 Loads properties for the Summary Information Stream.\r
655 </summary>\r
656 <param name="database">The MSI database.</param>\r
657 </member>\r
658 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CreateCabFile(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
659 <summary>\r
660 Creates a .cab file with all source files included.\r
661 </summary>\r
662 <param name="database">The MSI database.</param>\r
663 </member>\r
664 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
665 <summary>\r
666 Loads records for the sequence tables.\r
667 </summary>\r
668 <param name="database">The MSI database.</param>\r
669 </member>\r
670 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Schemas.Msi.MSIComponent,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,System.String,System.Int32@,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">\r
671 <summary>\r
672 Adds a file record to the Files table.\r
673 </summary>\r
674 <param name="database">The MSI database.</param>\r
675 <param name="directoryTable">The MSI database view.</param>\r
676 <param name="Component">The Component's XML Element.</param>\r
677 <param name="fileTable">The MSI database view.</param>\r
678 <param name="ComponentDirectory">The directory of this file's component.</param>\r
679 <param name="ComponentName">The name of this file's component.</param>\r
680 <param name="Sequence">The installation sequence number of this file.</param>\r
681 <param name="msiAssemblyTable">View containing the MsiAssembly table.</param>\r
682 <param name="msiAssemblyNameTable">View containing the MsiAssemblyName table.</param>\r
683 <param name="componentTable">View containing the Components table.</param>\r
684 <param name="featureComponentTable">View containing the FeatureComponents table.</param>\r
685 <param name="classTable">View containing the Class table.</param>\r
686 <param name="progIdTable">View containing the ProgId table.</param>\r
687 <param name="selfRegTable">View containing the SelfReg table.</param>\r
688 <param name="modComponentTable">ModuleComponent table.</param>\r
689 </member>\r
690 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadComponents(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">\r
691 <summary>\r
692 Loads records for the Components table.\r
693 </summary>\r
694 <param name="database">The MSI database.</param>\r
695 <param name="LastSequence">The sequence number of the last file in the .cab</param>\r
696 </member>\r
697 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.Execute">\r
698 <summary>\r
699 Executes the Task.\r
700 </summary>\r
701 <remarks>None.</remarks>\r
702 </member>\r
703 <member name="T:NAnt.Contrib.Tasks.Msi.InstallerDatabase">\r
704 <summary>\r
705 .NET wrapper for a Windows Installer database\r
706 </summary>\r
707 </member>\r
708 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables">\r
709 <summary>\r
710 Drops empty tables.\r
711 </summary>\r
712 </member>\r
713 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables(System.Boolean)">\r
714 <summary>\r
715 Drops the empty tables.\r
716 </summary>\r
717 <param name="isMergeModule">Determines if this is a merge module or not</param>\r
718 <remarks>If it is a merge module, the FeatureComponents table should not be dropped.</remarks>\r
719 </member>\r
720 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableEmpty(System.String)">\r
721 <summary>\r
722 Checks to see if the specified table is empty.\r
723 </summary>\r
724 <param name="TableName">Name of the table to check existance.</param>\r
725 <returns>True if empy and False if full.</returns>\r
726 </member>\r
727 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableExistance(System.String)">\r
728 <summary>\r
729 Checks to see if the specified table exists in the database\r
730 already.\r
731 </summary>\r
732 <param name="TableName">Name of the table to check existance.</param>\r
733 <returns>True if successful.</returns>\r
734 </member>\r
735 <member name="T:NAnt.Contrib.Tasks.Msi.Installer">\r
736 <remarks>\r
737 Helper class used to avoid errors when instantiating\r
738 WindowsInstaller.Installer. \r
739 </remarks>\r
740 </member>\r
741 <member name="T:NAnt.Contrib.Tasks.Msi.InstallerRecordReader">\r
742 <summary>\r
743 Use to read and manipulate existing records.\r
744 </summary>\r
745 </member>\r
746 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.#ctor(WindowsInstaller.View)">\r
747 <summary>\r
748 Creates a new reader for the entries in the view\r
749 </summary>\r
750 <param name="view">Database view to read entries from. Must be Execute()'ed already.</param>\r
751 </member>\r
752 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Read">\r
753 <summary>\r
754 Moves to the next record\r
755 </summary>\r
756 <returns>False iff no more records</returns>\r
757 </member>\r
758 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.DeleteCurrentRecord">\r
759 <summary>\r
760 Deletes the current record. Needs no Commit().\r
761 </summary>\r
762 </member>\r
763 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.SetValue(System.Int32,System.Object)">\r
764 <summary>\r
765 Set the value of a field in the current record. Remember to Commit()\r
766 </summary>\r
767 <param name="index">Zero-based index of the field to set</param>\r
768 <param name="value">New value</param>\r
769 </member>\r
770 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.GetString(System.Int32)">\r
771 <summary>\r
772 Get the string value of a field in the current record.\r
773 </summary>\r
774 <param name="index">Zero-based index of the field to get</param>\r
775 </member>\r
776 <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Commit">\r
777 <summary>\r
778 Commits changes to the current record.\r
779 </summary>\r
780 </member>\r
781 <member name="T:NAnt.Contrib.Tasks.Msi.InstallerSearchClause">\r
782 <summary>\r
783 A simple class for a single search clause.\r
784 TODO: more comparison types, use of the Composite pattern, etc.\r
785 </summary>\r
786 </member>\r
787 <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTable">\r
788 <summary>\r
789 Represents a single table in a Windows Installer archive\r
790 </summary>\r
791 </member>\r
792 <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTaskBase">\r
793 <summary>\r
794 Base class for msi/msm installer tasks\r
795 </summary>\r
796 </member>\r
797 <member name="T:NAnt.Contrib.Tasks.SchemaValidatedTask">\r
798 <summary>\r
799 Abstract <see cref="T:NAnt.Core.Task"/> that validates inheriting classes against \r
800 an XML schema of the same name.\r
801 </summary>\r
802 </member>\r
803 <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)">\r
804 <summary>\r
805 Initializes the task and verifies parameters.\r
806 </summary>\r
807 <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>\r
808 </member>\r
809 <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.Task_OnSchemaValidate(System.Object,System.Xml.Schema.ValidationEventArgs)">\r
810 <summary>\r
811 Occurs when a validation error is raised.\r
812 </summary>\r
813 <param name="sender">The object that sent the event.</param>\r
814 <param name="args">Validation arguments passed in.</param>\r
815 </member>\r
816 <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">\r
817 <summary>\r
818 Recursively expands properties of all attributes of \r
819 a nodelist and their children.\r
820 </summary>\r
821 <param name="Nodes">The nodes to recurse.</param>\r
822 </member>\r
823 <member name="P:NAnt.Contrib.Tasks.SchemaValidatedTask.SchemaObject">\r
824 <summary>\r
825 Returns the object from the Schema wrapper after \r
826 <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.\r
827 </summary>\r
828 <value>The object from the Schema wrapper after <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.</value>\r
829 </member>\r
830 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiOutput">\r
831 <summary>\r
832 The name of the file that will be generated when the task completes \r
833 execution (eg. MyInstall.msi or MyMergeModule.msm).\r
834 </summary>\r
835 </member>\r
836 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiSourceDir">\r
837 <summary>\r
838 A directory relative to the NAnt script in which the msi task resides \r
839 from which to retrieve files that will be installed by the msi \r
840 database. All files that will be included in your installation need \r
841 to be located directly within or in subdirectories of this directory. \r
842 </summary>\r
843 </member>\r
844 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiTemplate">\r
845 <summary>\r
846 A installer file to use as the starting database in which all files \r
847 and entries will be made, and then copied to the filename specified \r
848 by the output parameter. Install templates are included with the \r
849 install tasks, you only need to supply this value if you want to \r
850 override the default template. \r
851 </summary>\r
852 </member>\r
853 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiErrorTemplate">\r
854 <summary>\r
855 A .mst file to use as the starting database containing strings \r
856 displayed to the user when errors occur during installation. \r
857 A .mst template is included with the msi task, you only need to \r
858 supply this value if you want to override the default error \r
859 template and cannot perform something through the features of the \r
860 msi task.\r
861 </summary>\r
862 </member>\r
863 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiDebug">\r
864 <summary>\r
865 Causes the generated msi database file to contain debug messages for \r
866 errors created by inconsistencies in creation of the database. This \r
867 makes the file slightly larger and should be avoided when generating \r
868 a production release of your software.\r
869 </summary>\r
870 </member>\r
871 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSummaryInformationElement">\r
872 <summary>\r
873 <para>\r
874 Sets various properties in the SummaryInformation stream \r
875 (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp)\r
876 </para>\r
877 <para>\r
878 All of the sub-elements are optional.\r
879 </para>\r
880 <h3>Nested Elements:</h3>\r
881 <h4><title></h4>\r
882 <ul>\r
883 Briefly describes the type of installer package. Phrases such as "Installation Database" or \r
884 "Transform" or "Patch" may be used for this property.\r
885 <br />Default value: Value of the <c>ProductName</c> property, if defined.\r
886 </ul>\r
887 <h4></title></h4>\r
888 <h4><subject></h4>\r
889 <ul>\r
890 A short description of the product to be installed. This value is typically set from the installer \r
891 property <c>ProductName</c>\r
892 <br />Default value: Value of the <c>ProductName</c> property, if defined.\r
893 </ul>\r
894 <h4></subject></h4>\r
895 <h4><author></h4>\r
896 <ul>\r
897 The manufacturer of the installation database. This value is typically set from the installer \r
898 property <c>Manufacturer</c>.\r
899 <br />Default value: Value of the <c>Manufacturer</c> property, if defined.\r
900 </ul>\r
901 <h4></author></h4>\r
902 <h4><keywords></h4>\r
903 <ul>\r
904 Used by file browsers to hold keywords that permit the database file to be found in a keyword search. \r
905 The set of keywords typically includes "Installer" as well as product-specific keywords, and may be \r
906 localized.\r
907 <br />Default value: Value of the <c>Keywords</c> property, if defined.\r
908 </ul>\r
909 <h4></keywords></h4>\r
910 <h4><comments></h4>\r
911 <ul>\r
912 A general description/purpose of the installer database.\r
913 <br />Default value: Value of the <c>Comments</c> property, if defined.\r
914 </ul>\r
915 <h4></comments></h4>\r
916 <h4><template></h4>\r
917 <ul>\r
918 <para>\r
919 Indicates the platform and language versions that are supported by the database. The Template Summary \r
920 Property of a patch package is a semicolon-delimited list of the product codes that can accept the \r
921 patch.\r
922 </para>\r
923 <para>\r
924 See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information.\r
925 </para>\r
926 </ul>\r
927 <h4></template></h4>\r
928 <h4><revisionnumber></h4>\r
929 <ul>\r
930 Contains the package code (GUID) for the installer package. The package code is a unique identifier \r
931 of the installer package. Note: Default behavior - a new GUID is generated every time\r
932 </ul>\r
933 <h4></revisionnumber></h4>\r
934 <h4><creatingapplication></h4>\r
935 <ul>\r
936 The name of the application used to author the database. Note: Default value is NAnt.\r
937 </ul>\r
938 <h4></creatingapplication></h4>\r
939 <h3>Examples</h3>\r
940 <example>\r
941 <para>Define specific summary information.</para>\r
942 <code>\r
943 <summaryinformation>\r
944 <title>Installation Database</title>\r
945 <subject>${install.productname}</subject>\r
946 <author>${install.manufacturer}</author>\r
947 <keywords>MSI, database, NAnt, Installer</keywords>\r
948 <comments>This installer database contains the logic and data required to install NAnt</comments>\r
949 <template>;1033</template>\r
950 <creatingapplication>NAnt - http://nant.sf.net </creatingapplication>\r
951 </summaryinformation> \r
952 </code>\r
953 </example>\r
954 </summary>\r
955 </member>\r
956 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerPropertiesElement">\r
957 <summary>\r
958 <para>\r
959 Name/value pairs which will be set in the PROPERTY table of the \r
960 installer database.\r
961 </para>\r
962 <para>\r
963 The properties element contains within it one to any number of property elements.<br/>\r
964 <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Public property</see> names cannot contain lowercase letters.<br/>\r
965 <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Private property</see> names must contain some lowercase letters.<br/>\r
966 Property names prefixed with % represent system and user environment variables. These are \r
967 never entered into the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/property_table.asp">Property \r
968 table</see>. The permanent settings of environment variables can only be modified using the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">Environment Table</see>. \r
969 More information is available <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/properties.asp">here</see>.\r
970 </para>\r
971 <h3>Parameters</h3>\r
972 <list type="table">\r
973 <listheader>\r
974 <term>Attribute</term>\r
975 <term>Type</term>\r
976 <term>Description</term>\r
977 <term>Required</term>\r
978 </listheader>\r
979 <item>\r
980 <term>name</term>\r
981 <term>string</term>\r
982 <term>A name used to refer to the property.</term>\r
983 <term>True</term>\r
984 </item>\r
985 <item>\r
986 <term>value</term>\r
987 <term>string</term>\r
988 <term>The value of the property. This value can contain references to other, predefined properties to build a compound property.</term>\r
989 <term>True</term>\r
990 </item>\r
991 </list>\r
992 <h3>Examples</h3>\r
993 <example>\r
994 <para>Define the required properties.</para>\r
995 <code>\r
996 <properties>\r
997 <property name="ProductName" value="My Product" />\r
998 <property name="ProductVersion" value="1.0.0" />\r
999 <property name="Manufacturer" value="ACME Inc." />\r
1000 <property name="ProductCode" value="{29D8F096-3371-4cba-87E1-A8C6511F7B4C}" />\r
1001 <property name="UpgradeCode" value="{69E66919-0DE1-4280-B4C1-94049F76BA1A}" />\r
1002 </properties> \r
1003 </code>\r
1004 </example>\r
1005 </summary>\r
1006 </member>\r
1007 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSearchElement">\r
1008 <summary>\r
1009 <para>\r
1010 Contains within it one to any number of app, registry, ini, or dirfile elements. \r
1011 These elements are used to search for an existing filesystem directory, file, or \r
1012 Windows Registry setting. A property in the installer database is \r
1013 then set with the value obtained from the search.\r
1014 </para>\r
1015 <h3><app></h3>\r
1016 <para>\r
1017 More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/complocator_table.asp\r
1018 </para>\r
1019 <list type="table">\r
1020 <listheader>\r
1021 <term>Attribute</term>\r
1022 <term>Type</term>\r
1023 <term>Description</term>\r
1024 <term>Required</term>\r
1025 </listheader>\r
1026 <item>\r
1027 <term>componentid</term>\r
1028 <term>string</term>\r
1029 <term>The component ID of the component whose key path is to be used for the search.</term>\r
1030 <term>True</term>\r
1031 </item>\r
1032 <item>\r
1033 <term>type</term>\r
1034 <term>msi:MSILocatorTypeDirFile</term>\r
1035 <term>Valid input: <c>file</c> or <c>directory</c></term>\r
1036 <term>True</term>\r
1037 </item>\r
1038 <item>\r
1039 <term>setproperty</term>\r
1040 <term>string</term>\r
1041 <term>A name used to refer to the property within the Msi database. Set at install time.</term>\r
1042 <term>True</term>\r
1043 </item>\r
1044 </list>\r
1045 <h3></app></h3>\r
1046 <h3><registry></h3>\r
1047 <para>\r
1048 More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/reglocator_table.asp\r
1049 </para>\r
1050 <list type="table">\r
1051 <listheader>\r
1052 <term>Attribute</term>\r
1053 <term>Type</term>\r
1054 <term>Description</term>\r
1055 <term>Required</term>\r
1056 </listheader>\r
1057 <item>\r
1058 <term>type</term>\r
1059 <term>msi:MSILocatorTypeDirFileReg64</term>\r
1060 <term>Valid input: <c>registry</c>, <c>file</c>, <c>directory</c>, <c>64bit</c></term>\r
1061 <term>True</term>\r
1062 </item>\r
1063 <item>\r
1064 <term>path</term>\r
1065 <term>string</term>\r
1066 <term>Depending on the <c>type</c> specified: \r
1067 <list type="bullet">\r
1068 <item>Path is a directory.</item>\r
1069 <item>Path is a registry key.</item>\r
1070 </list>\r
1071 </term>\r
1072 <term>True</term>\r
1073 </item>\r
1074 <item>\r
1075 <term>root</term>\r
1076 <term>msi:MSIRegistryKeyRoot</term>\r
1077 <term>Valid input: \r
1078 <list type="bullet">\r
1079 <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>\r
1080 <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>\r
1081 <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>\r
1082 <item><c>user</c> represents HKEY_CURRENT_USER</item>\r
1083 <item><c>users</c> represents HKEY_USERS</item>\r
1084 </list>\r
1085 </term>\r
1086 <term>True</term>\r
1087 </item>\r
1088 </list>\r
1089 <ul>\r
1090 <h3>Nested Elements:</h3>\r
1091 <h4><value></h4>\r
1092 <h3>Parameters</h3>\r
1093 <list type="table">\r
1094 <listheader>\r
1095 <term>Attribute</term>\r
1096 <term>Type</term>\r
1097 <term>Description</term>\r
1098 <term>Required</term>\r
1099 </listheader>\r
1100 <item>\r
1101 <term>name</term>\r
1102 <term>string</term>\r
1103 <term>Depending on the <c>type</c> specified: \r
1104 <list type="bullet">\r
1105 <item>Key path is a file name.</item>\r
1106 <item>Key path is a registry value.</item>\r
1107 </list>\r
1108 </term>\r
1109 <term>False</term>\r
1110 </item>\r
1111 <item>\r
1112 <term>setproperty</term>\r
1113 <term>string</term>\r
1114 <term>A name used to refer to the property within the Msi database. Set at install time.</term>\r
1115 <term>True</term>\r
1116 </item>\r
1117 </list>\r
1118 <h4></value></h4>\r
1119 </ul>\r
1120 <h3></registry></h3>\r
1121 <h3><ini></h3>\r
1122 <para>\r
1123 More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/inilocator_table.asp\r
1124 </para>\r
1125 <list type="table">\r
1126 <listheader>\r
1127 <term>Attribute</term>\r
1128 <term>Type</term>\r
1129 <term>Description</term>\r
1130 <term>Required</term>\r
1131 </listheader>\r
1132 <item>\r
1133 <term>filename</term>\r
1134 <term>string</term>\r
1135 <term>The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.)\r
1136 </term>\r
1137 <term>True</term>\r
1138 </item>\r
1139 <item>\r
1140 <term>section</term>\r
1141 <term>string</term>\r
1142 <term>Section name within the .ini file.\r
1143 </term>\r
1144 <term>True</term>\r
1145 </item>\r
1146 <item>\r
1147 <term>key</term>\r
1148 <term>string</term>\r
1149 <term>Key value within the section.\r
1150 </term>\r
1151 <term>True</term>\r
1152 </item>\r
1153 <item>\r
1154 <term>field</term>\r
1155 <term>msi:nonNegativeInt</term>\r
1156 <term>The field in the .ini line. If Field is Null or 0, then the entire line is read. \r
1157 This must be a non-negative number.\r
1158 </term>\r
1159 <term>False</term>\r
1160 </item>\r
1161 <item>\r
1162 <term>type</term>\r
1163 <term>msi:MSILocatorTypeDirFileRaw</term>\r
1164 <term>Valid input: <c>file</c> ,<c>directory</c>, or <c>raw</c></term>\r
1165 <term>True</term>\r
1166 </item>\r
1167 <item>\r
1168 <term>setproperty</term>\r
1169 <term>string</term>\r
1170 <term>A name used to refer to the property within the Msi database. Set at install time.</term>\r
1171 <term>True</term>\r
1172 </item>\r
1173 </list>\r
1174 <h3></ini></h3>\r
1175 <h3><dirfile></h3>\r
1176 <para>\r
1177 More information on these attributes can be found at: \r
1178 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/drlocator_table.asp\r
1179 and\r
1180 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/signature_table.asp\r
1181 </para>\r
1182 <list type="table">\r
1183 <listheader>\r
1184 <term>Attribute</term>\r
1185 <term>Type</term>\r
1186 <term>Description</term>\r
1187 <term>Required</term>\r
1188 </listheader>\r
1189 <item>\r
1190 <term>parent</term>\r
1191 <term>string</term>\r
1192 <term>An identifier to RegLocator, IniLocator, or CompLocator tables. \r
1193 If it does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path.\r
1194 <br/>In order to determine what the key is for a table, prefix the property name assigned\r
1195 to that locator with SIG_\r
1196 </term>\r
1197 <term>False</term>\r
1198 </item>\r
1199 <item>\r
1200 <term>path</term>\r
1201 <term>string</term>\r
1202 <term>the path on the user's system. This is a either a full path or a relative subpath \r
1203 below the directory specified in the Parent column.\r
1204 </term>\r
1205 <term>False</term>\r
1206 </item>\r
1207 <item>\r
1208 <term>depth</term>\r
1209 <term>msi:nonNegativeInt</term>\r
1210 <term>The depth below the path that the installer searches for the file or directory.\r
1211 </term>\r
1212 <term>False</term>\r
1213 </item>\r
1214 <item>\r
1215 <term>setproperty</term>\r
1216 <term>string</term>\r
1217 <term>A name used to refer to the property within the Msi database. Set at install time.</term>\r
1218 <term>True</term>\r
1219 </item>\r
1220 </list>\r
1221 <ul>\r
1222 <h3>Nested Elements:</h3>\r
1223 <h4><file></h4>\r
1224 <h3>Parameters</h3>\r
1225 <list type="table">\r
1226 <listheader>\r
1227 <term>Attribute</term>\r
1228 <term>Type</term>\r
1229 <term>Description</term>\r
1230 <term>Required</term>\r
1231 </listheader>\r
1232 <item>\r
1233 <term>name</term>\r
1234 <term>string</term>\r
1235 <term>The name of the file.</term>\r
1236 <term>True</term>\r
1237 </item>\r
1238 <item>\r
1239 <term>minversion</term>\r
1240 <term>string</term>\r
1241 <term>The minimum version of the file, with a language comparison. If this field is \r
1242 specified, then the file must have a version that is at least equal to MinVersion. \r
1243 If the file has an equal version to the MinVersion field value but the language \r
1244 specified in the Languages column differs, the file does not satisfy the signature \r
1245 filter criteria.</term>\r
1246 <term>False</term>\r
1247 </item>\r
1248 <item>\r
1249 <term>maxversion</term>\r
1250 <term>string</term>\r
1251 <term>The maximum version of the file. If this field is specified, then the file \r
1252 must have a version that is at most equal to MaxVersion.</term>\r
1253 <term>False</term>\r
1254 </item>\r
1255 <item>\r
1256 <term>minsize</term>\r
1257 <term>msi:nonNegativeInt</term>\r
1258 <term>The minimum size of the file. If this field is specified, then the file \r
1259 under inspection must have a size that is at least equal to MinSize. This must \r
1260 be a non-negative number.</term>\r
1261 <term>False</term>\r
1262 </item>\r
1263 <item>\r
1264 <term>maxsize</term>\r
1265 <term>msi:nonNegativeInt</term>\r
1266 <term>The maximum size of the file. If this field is specified, then the file \r
1267 under inspection must have a size that is at most equal to MaxSize. This must \r
1268 be a non-negative number.</term>\r
1269 <term>False</term>\r
1270 </item>\r
1271 <item>\r
1272 <term>mindate</term>\r
1273 <term>msi:nonNegativeInt</term>\r
1274 <term>The minimum modification date and time of the file. If this field is \r
1275 specified, then the file under inspection must have a modification date and time \r
1276 that is at least equal to MinDate. This must be a non-negative number.</term>\r
1277 <term>False</term>\r
1278 </item>\r
1279 <item>\r
1280 <term>maxdate</term>\r
1281 <term>msi:nonNegativeInt</term>\r
1282 <term>The maximum creation date of the file. If this field is specified, then the \r
1283 file under inspection must have a creation date that is at most equal to MaxDate. \r
1284 This must be a non-negative number.</term>\r
1285 <term>False</term>\r
1286 </item>\r
1287 <item>\r
1288 <term>languages</term>\r
1289 <term>string</term>\r
1290 <term>The languages supported by the file.</term>\r
1291 <term>False</term>\r
1292 </item>\r
1293 </list>\r
1294 <h4></file></h4>\r
1295 </ul>\r
1296 <h3></dirfile></h3>\r
1297 <h3>Examples</h3>\r
1298 <example>\r
1299 <para>Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values.</para>\r
1300 <code>\r
1301 <search>\r
1302 <registry type="registry" path="Software\Microsoft\InetStp" root="machine" >\r
1303 <value name="PathWWWRoot" setproperty="IISWWWROOT" />\r
1304 </registry>\r
1305 <registry type="registry" path="SYSTEM\CurrentControlSet\Services\W3SVC\Parameters" root="machine" >\r
1306 <value name="MajorVersion" setproperty="IISVERSION" />\r
1307 </registry>\r
1308 </search> \r
1309 </code>\r
1310 </example>\r
1311 <example>\r
1312 <para>Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values.</para>\r
1313 <code>\r
1314 <search>\r
1315 <registry type="registry" path="Software\Microsoft\MessengerService" root="machine" >\r
1316 <value setproperty="MSGSRVNAME" />\r
1317 <value name="" setproperty="MSGSRVNAME2" />\r
1318 </registry>\r
1319 </search> \r
1320 </code>\r
1321 </example>\r
1322 </summary>\r
1323 </member>\r
1324 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerLaunchConditionsElement">\r
1325 <summary>\r
1326 <para>\r
1327 Contains within it one to any number of launchcondition elements. \r
1328 Launch conditions are conditions that all must be satisfied for the \r
1329 installation to begin.\r
1330 </para>\r
1331 <h3>Parameters</h3>\r
1332 <list type="table">\r
1333 <listheader>\r
1334 <term>Attribute</term>\r
1335 <term>Type</term>\r
1336 <term>Description</term>\r
1337 <term>Required</term>\r
1338 </listheader>\r
1339 <item>\r
1340 <term>name</term>\r
1341 <term>string</term>\r
1342 <term>A name used to identify the launch condition.</term>\r
1343 <term>True</term>\r
1344 </item>\r
1345 <item>\r
1346 <term>condition</term>\r
1347 <term>string</term>\r
1348 <term>Expression that must evaluate to True for installation to begin.</term>\r
1349 <term>True</term>\r
1350 </item>\r
1351 </list>\r
1352 <h3>Nested Elements:</h3>\r
1353 <h4><description></h4>\r
1354 <ul>\r
1355 Localizable text to display when the condition fails and the installation must be terminated.\r
1356 </ul>\r
1357 <h4></description></h4>\r
1358 <h3>Examples</h3>\r
1359 <example>\r
1360 <para>Create a check to make sure that IIS 5.x is installed.</para>\r
1361 <code>\r
1362 <launchconditions>\r
1363 <launchcondition name="CheckIIS" condition="(IISVERSION = &quot;#5&quot;)" >\r
1364 <description>\r
1365 This setup requires Internet information Server 5.x. Please install Internet Information Server and run this setup again.\r
1366 </description>\r
1367 </launchcondition>\r
1368 </launchconditions>\r
1369 </code>\r
1370 </example>\r
1371 </summary>\r
1372 </member>\r
1373 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerTablesElement">\r
1374 <summary>\r
1375 <para>\r
1376 Creates custom tables not directly managed by default features of \r
1377 the installer task.\r
1378 </para>\r
1379 <h3>Parameters</h3>\r
1380 <list type="table">\r
1381 <listheader>\r
1382 <term>Attribute</term>\r
1383 <term>Type</term>\r
1384 <term>Description</term>\r
1385 <term>Required</term>\r
1386 </listheader>\r
1387 <item>\r
1388 <term>name</term>\r
1389 <term>string</term>\r
1390 <term>A unique name used to identify the table.</term>\r
1391 <term>True</term>\r
1392 </item>\r
1393 </list>\r
1394 <h3>Nested Elements:</h3>\r
1395 <h4><columns></h4>\r
1396 <ul>\r
1397 <h4><column></h4>\r
1398 <ul>\r
1399 Defines the columns making up the table\r
1400 <h3>Parameters</h3>\r
1401 <list type="table">\r
1402 <listheader>\r
1403 <term>Attribute</term>\r
1404 <term>Type</term>\r
1405 <term>Description</term>\r
1406 <term>Required</term>\r
1407 </listheader>\r
1408 <item>\r
1409 <term>name</term>\r
1410 <term>string</term>\r
1411 <term>A unique name used to define the column.</term>\r
1412 <term>True</term>\r
1413 </item>\r
1414 <item>\r
1415 <term>nullable</term>\r
1416 <term>bool</term>\r
1417 <term>When set to <c>true</c>, allows the column to accept null values; <c>false</c> does not allow null values.</term>\r
1418 <term>True</term>\r
1419 </item>\r
1420 <item>\r
1421 <term>category</term>\r
1422 <term>msi:MSITableColumnCategoryType</term>\r
1423 <term>Valid input:\r
1424 <list type="bullet">\r
1425 <item><c>Text</c></item>\r
1426 <item><c>UpperCase</c></item>\r
1427 <item><c>LowerCase</c></item>\r
1428 <item><c>Integer</c></item>\r
1429 <item><c>DoubleInteger</c></item>\r
1430 <item><c>Time/Date</c></item>\r
1431 <item><c>Identifier</c></item>\r
1432 <item><c>Property</c></item>\r
1433 <item><c>Filename</c></item>\r
1434 <item><c>WildCardFilename</c></item>\r
1435 <item><c>Path</c></item>\r
1436 <item><c>Paths</c></item>\r
1437 <item><c>AnyPath</c></item>\r
1438 <item><c>DefaultDir</c></item>\r
1439 <item><c>RegPath</c></item>\r
1440 <item><c>Formatted</c></item>\r
1441 <item><c>Template</c></item>\r
1442 <item><c>Condition</c></item>\r
1443 <item><c>GUID</c></item>\r
1444 <item><c>Version</c></item>\r
1445 <item><c>Language</c></item>\r
1446 <item><c>Binary</c></item>\r
1447 <item><c>Cabinet</c></item>\r
1448 <item><c>Shortcut</c></item>\r
1449 </list>\r
1450 More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp">http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp</a>\r
1451 </term>\r
1452 <term>False</term>\r
1453 </item>\r
1454 <item>\r
1455 <term>type</term>\r
1456 <term>string</term>\r
1457 <term>Overrides the <c>category</c> specification. An example of valid input would be: <c>S255</c></term>\r
1458 <term>False</term>\r
1459 </item>\r
1460 <item>\r
1461 <term>key</term>\r
1462 <term>bool</term>\r
1463 <term>When set to <c>true</c>, the column is used to form the primary key for the table; <c>false</c> specifies that the column is not used to form the primary key.</term>\r
1464 <term>False</term>\r
1465 </item>\r
1466 <item>\r
1467 <term>minvalue</term>\r
1468 <term>int</term>\r
1469 <term>This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string.</term>\r
1470 <term>False</term>\r
1471 </item>\r
1472 <item>\r
1473 <term>maxvalue</term>\r
1474 <term>int</term>\r
1475 <term>This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. </term>\r
1476 <term>False</term>\r
1477 </item>\r
1478 <item>\r
1479 <term>keytable</term>\r
1480 <term>string</term>\r
1481 <term>This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons.</term>\r
1482 <term>False</term>\r
1483 </item>\r
1484 <item>\r
1485 <term>keycolumn</term>\r
1486 <term>int</term>\r
1487 <term>This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32.</term>\r
1488 <term>False</term>\r
1489 </item>\r
1490 <item>\r
1491 <term>set</term>\r
1492 <term>string</term>\r
1493 <term>This is a list of permissible values for this field separated by semicolons. This field is usually used for enums.</term>\r
1494 <term>False</term>\r
1495 </item>\r
1496 <item>\r
1497 <term>description</term>\r
1498 <term>string</term>\r
1499 <term>A description of the data that is stored in the column. </term>\r
1500 <term>False</term>\r
1501 </item>\r
1502 </list>\r
1503 </ul>\r
1504 <h4></column></h4>\r
1505 </ul>\r
1506 <h4></columns></h4>\r
1507 <h4><rows></h4>\r
1508 <ul>\r
1509 <h4><row></h4>\r
1510 <ul>\r
1511 Defines the data for a row in the table\r
1512 <h4><columns></h4>\r
1513 <ul>\r
1514 <h4><column></h4>\r
1515 <ul>\r
1516 Defines data for a specific cell in the row\r
1517 <h3>Parameters</h3>\r
1518 <list type="table">\r
1519 <listheader>\r
1520 <term>Attribute</term>\r
1521 <term>Type</term>\r
1522 <term>Description</term>\r
1523 <term>Required</term>\r
1524 </listheader>\r
1525 <item>\r
1526 <term>name</term>\r
1527 <term>string</term>\r
1528 <term>Name of the column to populate.</term>\r
1529 <term>True</term>\r
1530 </item>\r
1531 <item>\r
1532 <term>value</term>\r
1533 <term>string</term>\r
1534 <term>Value to populate the cell with.</term>\r
1535 <term>True</term>\r
1536 </item>\r
1537 </list>\r
1538 </ul>\r
1539 <h4></column></h4>\r
1540 </ul>\r
1541 <h4></columns></h4>\r
1542 </ul>\r
1543 <h4></row></h4>\r
1544 </ul>\r
1545 <h4></rows></h4>\r
1546 <h3>Examples</h3>\r
1547 <example>\r
1548 <para>\r
1549 Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table.\r
1550 </para>\r
1551 <code>\r
1552 <tables>\r
1553 <table name="IniFile">\r
1554 <columns>\r
1555 <column name="IniFile" nullable="false" category="Identifier" key="true" description="The key for this table." />\r
1556 <column name="FileName" nullable="false" category="Text" description="The localizable name of the .ini file in which to write the information. " />\r
1557 <column name="DirProperty" nullable="true" category="Identifier" description="Name of a property having a value that resolves to the full path of the folder containing the .ini file. " /> \r
1558 <column name="Section" nullable="false" category="Formatted" description="The localizable .ini file section." />\r
1559 <column name="Key" nullable="false" category="Formatted" description="The localizable .ini file key within the section" />\r
1560 <column name="Value" nullable="false" category="Formatted" description="The localizable value to be written. " />\r
1561 <column name="Action" nullable="false" category="Integer" description="The type of modification to be made. " />\r
1562 <column name="Component_" nullable="false" category="Identifier" description="External key into the first column of the Component table referencing the component that controls the installation of the .ini value. " />\r
1563 </columns>\r
1564 <rows>\r
1565 <row>\r
1566 <columns>\r
1567 <column name="IniFile" value="MyInternetShortcut" />\r
1568 <column name="FileName" value="MyInternetAddr.url" />\r
1569 <column name="DirProperty" value="D__MYDIR" />\r
1570 <column name="Section" value="InternetShortcut" />\r
1571 <column name="Key" value="URL" />\r
1572 <column name="Value" value="[TARGETURL]" />\r
1573 <column name="Action" value="0" />\r
1574 <column name="Component_" value="C__Documentation" />\r
1575 </columns>\r
1576 </row>\r
1577 </rows>\r
1578 </table>\r
1579 </tables>\r
1580 </code>\r
1581 </example>\r
1582 </summary>\r
1583 </member>\r
1584 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDirectoriesElement">\r
1585 <summary>\r
1586 <para>\r
1587 Specifies the directory layout for the product.\r
1588 </para>\r
1589 <h3>Parameters</h3>\r
1590 <list type="table">\r
1591 <listheader>\r
1592 <term>Attribute</term>\r
1593 <term>Type</term>\r
1594 <term>Description</term>\r
1595 <term>Required</term>\r
1596 </listheader>\r
1597 <item>\r
1598 <term>name</term>\r
1599 <term>string</term>\r
1600 <term>A name used to refer to the directory.</term>\r
1601 <term>True</term>\r
1602 </item>\r
1603 <item>\r
1604 <term>foldername</term>\r
1605 <term>string</term>\r
1606 <term>The directory's name (localizable)under the parent directory.</term>\r
1607 <term>True</term>\r
1608 </item>\r
1609 <item>\r
1610 <term>root</term>\r
1611 <term>string</term>\r
1612 <term>A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template:\r
1613 <list type="bullet">\r
1614 <item><c>AdminToolsFolder</c></item>\r
1615 <item><c>AppDataFolder</c></item>\r
1616 <item><c>CommonAppDataFolder</c></item>\r
1617 <item><c>CommonFiles64Folder</c></item>\r
1618 <item><c>CommonFilesFolder</c></item>\r
1619 <item><c>DesktopFolder</c></item>\r
1620 <item><c>FavoritesFolder</c></item>\r
1621 <item><c>FontsFolder</c></item>\r
1622 <item><c>LocalAppDataFolder</c></item>\r
1623 <item><c>MyPicturesFolder</c></item>\r
1624 <item><c>PersonalFolder</c></item>\r
1625 <item><c>ProgramFilesFolder</c></item>\r
1626 <item><c>ProgramMenuFolder</c></item>\r
1627 <item><c>ProgramFiles64Folder</c></item>\r
1628 <item><c>SendToFolder</c></item>\r
1629 <item><c>StartMenuFolder</c></item>\r
1630 <item><c>StartupFolder</c></item>\r
1631 <item><c>System16Folder</c></item>\r
1632 <item><c>System64Folder</c></item>\r
1633 <item><c>SystemFolder</c></item>\r
1634 <item><c>TARGETDIR</c></item>\r
1635 <item><c>TempFolder</c></item>\r
1636 <item><c>TemplateFolder</c></item>\r
1637 <item><c>WindowsFolder</c></item>\r
1638 <item><c>WindowsVolume</c></item>\r
1639 </list>\r
1640 </term>\r
1641 <term>True</term>\r
1642 </item>\r
1643 </list>\r
1644 <h3>Nested Elements:</h3>\r
1645 <h4><directory></h4>\r
1646 <ul>\r
1647 Sub directories. Note, this element can contain nested <directory/> sub elements.\r
1648 <h3>Parameters</h3>\r
1649 <list type="table">\r
1650 <listheader>\r
1651 <term>Attribute</term>\r
1652 <term>Type</term>\r
1653 <term>Description</term>\r
1654 <term>Required</term>\r
1655 </listheader>\r
1656 <item>\r
1657 <term>name</term>\r
1658 <term>string</term>\r
1659 <term>A name used to refer to the directory.</term>\r
1660 <term>True</term>\r
1661 </item>\r
1662 <item>\r
1663 <term>foldername</term>\r
1664 <term>string</term>\r
1665 <term>The directory's name (localizable)under the parent directory.</term>\r
1666 <term>True</term>\r
1667 </item>\r
1668 </list>\r
1669 </ul>\r
1670 <h4></directory></h4>\r
1671 <h3>Examples</h3>\r
1672 <example>\r
1673 <para>Define a sample directory structure.</para>\r
1674 <code>\r
1675 <directories>\r
1676 <directory name="D__ACME" foldername="ACME" root="TARGETDIR" >\r
1677 <directory name="D__ACME_MyProduct" foldername="My Product" />\r
1678 </directory>\r
1679 </directories> \r
1680 </code>\r
1681 </example>\r
1682 </summary>\r
1683 </member>\r
1684 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerEnvironmentElement">\r
1685 <summary>\r
1686 <para>\r
1687 Used to modify the environment variables of the target computer at \r
1688 runtime.\r
1689 </para>\r
1690 <h3>Parameters</h3>\r
1691 <list type="table">\r
1692 <listheader>\r
1693 <term>Attribute</term>\r
1694 <term>Type</term>\r
1695 <term>Description</term>\r
1696 <term>Required</term>\r
1697 </listheader>\r
1698 <item>\r
1699 <term>name</term>\r
1700 <term>string</term>\r
1701 <term>The localizable name of the environment variable. The key values are written or removed depending upon \r
1702 which of the characters in the following table are prefixed to the name. There is no effect in the ordering of \r
1703 the symbols used in a prefix.\r
1704 <list type="table">\r
1705 <listheader>\r
1706 <term>Prefix</term>\r
1707 <description>Description</description>\r
1708 </listheader>\r
1709 <item>\r
1710 <term>=</term>\r
1711 <description>Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation.</description>\r
1712 </item>\r
1713 <item>\r
1714 <term>+</term>\r
1715 <description>Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists.</description>\r
1716 </item>\r
1717 <item>\r
1718 <term>-</term>\r
1719 <description>Remove the environment variable when the component is removed. This symbol can be combined with any prefix.</description>\r
1720 </item>\r
1721 <item>\r
1722 <term>!</term>\r
1723 <description>Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty.</description>\r
1724 </item>\r
1725 <item>\r
1726 <term>*</term>\r
1727 <description>This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a></description>\r
1728 </item>\r
1729 <item>\r
1730 <term>=-</term>\r
1731 <description>The environment variable is set on install and removed on uninstall. This is the usual behavior.</description>\r
1732 </item>\r
1733 <item>\r
1734 <term>!-</term>\r
1735 <description>Removes an environment variable during an install or uninstall.</description>\r
1736 </item>\r
1737 </list>\r
1738 More information can be found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a>\r
1739 </term>\r
1740 <term>True</term>\r
1741 </item>\r
1742 <item>\r
1743 <term>append</term>\r
1744 <term>string</term>\r
1745 <term>Localizable value that is to be set as a <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">formatted</a> string</term>\r
1746 <term>True</term>\r
1747 </item>\r
1748 <item>\r
1749 <term>component</term>\r
1750 <term>string</term>\r
1751 <term>Refrence to a component. Allows the variabled to be modified when the component is un/installed.</term>\r
1752 <term>True</term>\r
1753 </item>\r
1754 </list>\r
1755 <h3>Examples</h3>\r
1756 <example>\r
1757 <para>Append the installation path to the user PATH variable.</para>\r
1758 <code>\r
1759 <environment>\r
1760 <variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" />\r
1761 </environment>\r
1762 </code>\r
1763 </example>\r
1764 </summary>\r
1765 </member>\r
1766 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerComponentsElement">\r
1767 <summary>\r
1768 <para>\r
1769 Groups sets of files into named sets, these can be used to install \r
1770 and perform operations on a set of files as one entity. \r
1771 </para>\r
1772 <h3>Parameters</h3>\r
1773 <list type="table">\r
1774 <listheader>\r
1775 <term>Attribute</term>\r
1776 <term>Type</term>\r
1777 <term>Description</term>\r
1778 <term>Required</term>\r
1779 </listheader>\r
1780 <item>\r
1781 <term>name</term>\r
1782 <term>string</term>\r
1783 <term>A name used to refer to the component.</term>\r
1784 <term>True</term>\r
1785 </item>\r
1786 <item>\r
1787 <term>id</term>\r
1788 <term>string</term>\r
1789 <term>A string GUID unique to this component, version, and language.<br/>Note that the letters of these GUIDs must be \r
1790 uppercase. Utilities such as GUIDGEN can generate GUIDs containing lowercase letters. The lowercase letters must be \r
1791 changed to uppercase to make these valid component code GUIDs.\r
1792 </term>\r
1793 <term>True</term>\r
1794 </item>\r
1795 <item>\r
1796 <term>attr</term>\r
1797 <term>int</term>\r
1798 <term>This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option. \r
1799 <list type="table">\r
1800 <listheader>\r
1801 <term>Value</term>\r
1802 <description>Description</description>\r
1803 </listheader>\r
1804 <item>\r
1805 <term>0</term>\r
1806 <description>Component cannot be run from source. <br/>\r
1807 Set this bit for all components belonging to a feature to prevent the feature from being run-from-network or \r
1808 run-from-source. Note that if a feature has no components, the feature always shows run-from-source and \r
1809 run-from-my-computer as valid options.\r
1810 </description>\r
1811 </item>\r
1812 <item>\r
1813 <term>1</term>\r
1814 <description>Component can only be run from source. <br/>\r
1815 Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer. \r
1816 Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer as \r
1817 valid options.\r
1818 </description>\r
1819 </item>\r
1820 <item>\r
1821 <term>2</term>\r
1822 <description>Component can run locally or from source.</description>\r
1823 </item>\r
1824 <item>\r
1825 <term>4</term>\r
1826 <description>If this bit is set, the value in the key element is used as a key into the Registry table.<br/>\r
1827 If the Value field of the corresponding record in the Registry table is null, the Name field in that record must \r
1828 not contain "+", "-", or "*". For more information, see the description of the Name field in Registry table.<br/>\r
1829 Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer writes \r
1830 the necessary HKCU registry entries when there are multiple users on the same machine.\r
1831 </description>\r
1832 </item>\r
1833 <item>\r
1834 <term>16</term>\r
1835 <description>If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings.\r
1836 </description>\r
1837 </item>\r
1838 <item>\r
1839 <term>32</term>\r
1840 <description>If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table.</description>\r
1841 </item>\r
1842 <item>\r
1843 <term>64</term>\r
1844 <description>If this bit is set, the installer reevaluates the value of the statement in the Condition column \r
1845 upon a reinstall. If the value was previously False and has changed to True, the installer installs the component. \r
1846 If the value was previously True and has changed to False, the installer removes the component even if the component \r
1847 has other products as clients. <br/>This bit should only be set for transitive components. See Using Transitive \r
1848 Components.\r
1849 </description>\r
1850 </item>\r
1851 <item>\r
1852 <term>128</term>\r
1853 <description>If this bit is set, the installer does not install or reinstall the component if a key path file or \r
1854 a key path registry entry for the component already exists. The application does register itself as a client of \r
1855 the component. <br/>\r
1856 Use this flag only for components that are being registered by the Registry table.\r
1857 </description>\r
1858 </item>\r
1859 <item>\r
1860 <term>256</term>\r
1861 <description>Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of \r
1862 packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered \r
1863 as a 32-bit component.\r
1864 </description>\r
1865 </item>\r
1866 </list>\r
1867 </term>\r
1868 <term>True</term>\r
1869 </item>\r
1870 <item>\r
1871 <term>directory</term>\r
1872 <term>string</term>\r
1873 <term>Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed.</term>\r
1874 <term>True</term>\r
1875 </item>\r
1876 <item>\r
1877 <term>feature</term>\r
1878 <term>string</term>\r
1879 <term>Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not.</term>\r
1880 <term>True</term>\r
1881 </item>\r
1882 <item>\r
1883 <term>condition</term>\r
1884 <term>string</term>\r
1885 <term>A conditional statement that can control whether a component is installed. If the condition is null or evaluates to \r
1886 true, then the component is enabled. If the condition evaluates to False, then the component is disabled and is not \r
1887 installed.</term>\r
1888 <term>False</term>\r
1889 </item>\r
1890 <item>\r
1891 <term>fileattr</term>\r
1892 <term>int</term>\r
1893 <term>Integer containing bit flags representing file attributes.<br/> \r
1894 The following table shows the definition of the bit field.\r
1895 <list type="table">\r
1896 <listheader>\r
1897 <term>Value</term>\r
1898 <description>Description</description>\r
1899 </listheader>\r
1900 <item>\r
1901 <term>1</term>\r
1902 <description>Read-Only</description>\r
1903 </item>\r
1904 <item>\r
1905 <term>2</term>\r
1906 <description>Hidden</description>\r
1907 </item>\r
1908 <item>\r
1909 <term>4</term>\r
1910 <description>System</description>\r
1911 </item>\r
1912 <item>\r
1913 <term>512</term>\r
1914 <description>The file is vital for the proper operation of the component to which it belongs</description>\r
1915 </item>\r
1916 <item>\r
1917 <term>1024</term>\r
1918 <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>\r
1919 </item>\r
1920 <item>\r
1921 <term>4096</term>\r
1922 <description>This bit must only be added by a patch and if the file is being added by the patch.</description>\r
1923 </item>\r
1924 <item>\r
1925 <term>8192</term>\r
1926 <description>The file's source type is uncompressed. If set, ignore the Word Count Summary Property. \r
1927 If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression \r
1928 state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed \r
1929 and msidbFileAttributesCompressed.</description>\r
1930 </item>\r
1931 <item>\r
1932 <term>16384</term>\r
1933 <description>The file's source type is compressed. If set, ignore the Word Count Summary Property. \r
1934 If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of \r
1935 the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and \r
1936 msidbFileAttributesCompressed.</description>\r
1937 </item>\r
1938 </list>\r
1939 </term>\r
1940 <term>False</term>\r
1941 </item>\r
1942 <item>\r
1943 <term>checkinterop</term>\r
1944 <term>bool</term>\r
1945 <term>Used to determine if file(s) in the fileset are interop file(s). If <c>true</c>, extra information will be added in the install\r
1946 package to register each interop file. If <c>false</c>, the file(s) will not be not be checked and the extra registration information\r
1947 will not be added to the msi. </term>\r
1948 <term>False</term>\r
1949 </item>\r
1950 <item>\r
1951 <term>installassembliestogac</term>\r
1952 <term>bool</term>\r
1953 <term>Used to determine if assemblies should be installed to the Global Assembly Cache. \r
1954 If <c>true</c>, all assemblies in the fileset will be added to the GAC. If <c>false</c>, the assemblies will be installed\r
1955 to the specified directory (as a normal file would). Note: If an assembly is specified to be installed into the GAC, it will not\r
1956 also be installed to the directory specified.</term>\r
1957 <term>False</term>\r
1958 </item>\r
1959 <item>\r
1960 <term>keepsubdirs</term>\r
1961 <term>bool</term>\r
1962 <term>Used to determine if directories in the fileset should be built.\r
1963 If <c>true</c>, all subdirectories of the fileset basedir will be built. If <c>false</c> the directories structure will be\r
1964 flattened. The default is <c>false</c>.</term>\r
1965 <term>False</term>\r
1966 </item>\r
1967 </list>\r
1968 <h3>Nested Elements:</h3>\r
1969 <h4><keyfile></h4>\r
1970 <ul>\r
1971 This value points to a file or folder belonging to the component that the installer uses to detect the component. Two components cannot share the same key path value.\r
1972 <h3>Parameters</h3>\r
1973 <list type="table">\r
1974 <listheader>\r
1975 <term>Attribute</term>\r
1976 <term>Type</term>\r
1977 <term>Description</term>\r
1978 <term>Required</term>\r
1979 </listheader>\r
1980 <item>\r
1981 <term>file</term>\r
1982 <term>string</term>\r
1983 <term>Name of the key (file) to use. Also, this could be an id of a registry key value.</term>\r
1984 <term>True</term>\r
1985 </item>\r
1986 </list>\r
1987 </ul>\r
1988 <h4></keyfile></h4>\r
1989 <h4><fileset></h4>\r
1990 <ul>\r
1991 Specifies the files to include with the component\r
1992 </ul>\r
1993 <h4></fileset></h4>\r
1994 <h4><forceid></h4>\r
1995 <ul>\r
1996 Used to force specific attributes on a per file basis\r
1997 <h3>Parameters</h3>\r
1998 <list type="table">\r
1999 <listheader>\r
2000 <term>Attribute</term>\r
2001 <term>Type</term>\r
2002 <term>Description</term>\r
2003 <term>Required</term>\r
2004 </listheader>\r
2005 <item>\r
2006 <term>file</term>\r
2007 <term>string</term>\r
2008 <term>Name of the file, in the fileset, to override.</term>\r
2009 <term>True</term>\r
2010 </item>\r
2011 <item>\r
2012 <term>id</term>\r
2013 <term>string</term>\r
2014 <term>Unique GUID to assign to the file.</term>\r
2015 <term>True</term>\r
2016 </item>\r
2017 <item>\r
2018 <term>attr</term>\r
2019 <term>int</term>\r
2020 <term>Integer containing bit flags representing file attributes.<br/> \r
2021 The following table shows the definition of the bit field.\r
2022 <list type="table">\r
2023 <listheader>\r
2024 <term>Value</term>\r
2025 <description>Description</description>\r
2026 </listheader>\r
2027 <item>\r
2028 <term>1</term>\r
2029 <description>Read-Only</description>\r
2030 </item>\r
2031 <item>\r
2032 <term>2</term>\r
2033 <description>Hidden</description>\r
2034 </item>\r
2035 <item>\r
2036 <term>4</term>\r
2037 <description>System</description>\r
2038 </item>\r
2039 <item>\r
2040 <term>512</term>\r
2041 <description>The file is vital for the proper operation of the component to which it belongs</description>\r
2042 </item>\r
2043 <item>\r
2044 <term>1024</term>\r
2045 <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>\r
2046 </item>\r
2047 <item>\r
2048 <term>4096</term>\r
2049 <description>This bit must only be added by a patch and if the file is being added by the patch.</description>\r
2050 </item>\r
2051 <item>\r
2052 <term>8192</term>\r
2053 <description>The file's source type is uncompressed. If set, ignore the Word Count Summary Property. \r
2054 If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression \r
2055 state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed \r
2056 and msidbFileAttributesCompressed.</description>\r
2057 </item>\r
2058 <item>\r
2059 <term>16384</term>\r
2060 <description>The file's source type is compressed. If set, ignore the Word Count Summary Property. \r
2061 If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of \r
2062 the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and \r
2063 msidbFileAttributesCompressed.</description>\r
2064 </item>\r
2065 </list>\r
2066 </term>\r
2067 <term>False</term>\r
2068 </item>\r
2069 <item>\r
2070 <term>version</term>\r
2071 <term>string</term>\r
2072 <term>This field is the version string for a versioned file. This field is blank for non-versioned files.</term>\r
2073 <term>False</term>\r
2074 </item>\r
2075 <item>\r
2076 <term>language</term>\r
2077 <term>string</term>\r
2078 <term>A list of decimal language IDs separated by commas.</term>\r
2079 <term>False</term>\r
2080 </item>\r
2081 <item>\r
2082 <term>checkinterop</term>\r
2083 <term>bool</term>\r
2084 <term>Used to determine if file is an interop file. If <c>true</c>, extra information will be added in the install\r
2085 package to register the interop file. If <c>false</c>, the file will not be not be checked and the extra registration information\r
2086 will not be added to the msi.</term>\r
2087 <term>False</term>\r
2088 </item>\r
2089 <item>\r
2090 <term>installtogac</term>\r
2091 <term>bool</term>\r
2092 <term>If <c>true</c>, and if the file is an assembly, it will be installed to the GAC. If <c>false</c>, the file \r
2093 will be installed to the directory specified by the component. Note: If an assembly is specified to \r
2094 be installed into the GAC, it will not also be installed to the directory specified.</term>\r
2095 <term>False</term>\r
2096 </item>\r
2097 </list>\r
2098 </ul>\r
2099 <h4></forceid></h4>\r
2100 <h3>Examples</h3>\r
2101 <example>\r
2102 <para>Define a sample component structure.</para>\r
2103 <code>\r
2104 <components>\r
2105 <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" >\r
2106 <key file="default.aspx" />\r
2107 <fileset basedir="${install.dir}">\r
2108 <include name="*.*" />\r
2109 </fileset>\r
2110 </component>\r
2111 </components> \r
2112 </code>\r
2113 </example>\r
2114 <example>\r
2115 <para>Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR)</para>\r
2116 <code>\r
2117 <components>\r
2118 <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" installassembliestogac="true" >\r
2119 <key file="MyAssemblyName.xml" />\r
2120 <fileset basedir="${install.dir}">\r
2121 <include name="*.*" />\r
2122 </fileset>\r
2123 <forceid file="MyOtherAssembly.dll" id="_4EB7CCB23D394958988ED817DA00B9D1" installtogac="false" />\r
2124 </component>\r
2125 </components> \r
2126 </code>\r
2127 </example>\r
2128 <example>\r
2129 <para>Assign a registry entry to a specific component.</para>\r
2130 <code>\r
2131 <components>\r
2132 <component name="C__RegistryEntry" id="{06C654AA-273D-4E39-885C-3E5225D9F336}" attr="4" directory="TARGETDIR" feature="F__DefaultFeature" >\r
2133 <key file="R__822EC365A8754FACBF6C713BFE4E57F0" />\r
2134 </component>\r
2135 </components> \r
2136 .\r
2137 .\r
2138 .\r
2139 <registry>\r
2140 <key path="SOFTWARE\MyCompany\MyProduct\" root="machine" component="C__RegistryEntry">\r
2141 <value id="R__822EC365A8754FACBF6C713BFE4E57F0" name="MyKeyName" value="MyKeyValue" />\r
2142 </key>\r
2143 </registry>\r
2144 </code>\r
2145 </example>\r
2146 </summary>\r
2147 </member>\r
2148 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDialogsElement">\r
2149 <summary>\r
2150 <para>\r
2151 Creates custom dialogs that can gather information not handled by \r
2152 the default installer template.\r
2153 </para>\r
2154 <h3>Parameters</h3>\r
2155 <list type="table">\r
2156 <listheader>\r
2157 <term>Attribute</term>\r
2158 <term>Type</term>\r
2159 <term>Description</term>\r
2160 <term>Required</term>\r
2161 </listheader>\r
2162 <item>\r
2163 <term>name</term>\r
2164 <term>string</term>\r
2165 <term>A name used to refer to the dialog.</term>\r
2166 <term>True</term>\r
2167 </item>\r
2168 <item>\r
2169 <term>hcenter</term>\r
2170 <term>int</term>\r
2171 <term>Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge.</term>\r
2172 <term>True</term>\r
2173 </item>\r
2174 <item>\r
2175 <term>vcenter</term>\r
2176 <term>int</term>\r
2177 <term>Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge.</term>\r
2178 <term>True</term>\r
2179 </item>\r
2180 <item>\r
2181 <term>width</term>\r
2182 <term>int</term>\r
2183 <term>Width of the rectangular boundary of the dialog box. This number must be non-negative.</term>\r
2184 <term>True</term>\r
2185 </item>\r
2186 <item>\r
2187 <term>height</term>\r
2188 <term>int</term>\r
2189 <term>Height of the rectangular boundary of the dialog box. This number must be non-negative.</term>\r
2190 <term>True</term>\r
2191 </item>\r
2192 <item>\r
2193 <term>attr</term>\r
2194 <term>int</term>\r
2195 <term>A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative.\r
2196 <list type="table">\r
2197 <listheader>\r
2198 <term>Value</term>\r
2199 <description>Description</description>\r
2200 </listheader>\r
2201 <item>\r
2202 <term>1</term>\r
2203 <description>Visible</description>\r
2204 </item>\r
2205 <item>\r
2206 <term>2</term>\r
2207 <description>Modal</description>\r
2208 </item>\r
2209 <item>\r
2210 <term>4</term>\r
2211 <description>Minimize</description>\r
2212 </item>\r
2213 <item>\r
2214 <term>8</term>\r
2215 <description>SysModal</description>\r
2216 </item>\r
2217 <item>\r
2218 <term>16</term>\r
2219 <description>KeepModeless</description>\r
2220 </item>\r
2221 <item>\r
2222 <term>32</term>\r
2223 <description>TrackDiskSpace</description>\r
2224 </item>\r
2225 <item>\r
2226 <term>64</term>\r
2227 <description>UseCustomPalette</description>\r
2228 </item>\r
2229 <item>\r
2230 <term>128</term>\r
2231 <description>RTLRO</description>\r
2232 </item>\r
2233 <item>\r
2234 <term>256</term>\r
2235 <description>RightAligned</description>\r
2236 </item>\r
2237 <item>\r
2238 <term>512</term>\r
2239 <description>LeftScroll</description>\r
2240 </item>\r
2241 <item>\r
2242 <term>896</term>\r
2243 <description>BiDi</description>\r
2244 </item>\r
2245 <item>\r
2246 <term>65536</term>\r
2247 <description>Error</description>\r
2248 </item>\r
2249 </list>\r
2250 More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp">http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp</a>\r
2251 </term>\r
2252 <term>True</term>\r
2253 </item>\r
2254 <item>\r
2255 <term>title</term>\r
2256 <term>string</term>\r
2257 <term>A localizable text string specifying the title to be displayed in the title bar of the dialog box.</term>\r
2258 <term>True</term>\r
2259 </item>\r
2260 <item>\r
2261 <term>firstcontrol</term>\r
2262 <term>string</term>\r
2263 <term>An external key to the second column of the Control table. Combining this field with the Dialog field identifies a \r
2264 unique control in the Control table. This defines the control that takes the focus when the dialog box is created. This \r
2265 column is ignored in an Error dialog box. <br/>\r
2266 Because static text cannot take the focus, a Text control that describes an Edit, PathEdit, ListView, ComboBox or \r
2267 VolumeSelectCombo control must be made the first control in the dialog box to ensure compatibility with screen readers.\r
2268 </term>\r
2269 <term>True</term>\r
2270 </item>\r
2271 <item>\r
2272 <term>defaultcontrol</term>\r
2273 <term>string</term>\r
2274 <term>An external key to the second column of the Control table. Combining this field with the Dialog field results in \r
2275 a primary key into the Control table that defines the default control. Hitting the Return key is equivalent to clicking \r
2276 on the default control. If this column is left blank, then there is no default control. This column is ignored in the \r
2277 Error dialog box. \r
2278 </term>\r
2279 <term>True</term>\r
2280 </item>\r
2281 <item>\r
2282 <term>cancelcontrol</term>\r
2283 <term>string</term>\r
2284 <term>An external key to the second column of the Control table. Combining this field with the Dialog field results in \r
2285 a primary key of the Control table that defines the cancel control. Hitting the ESC key or clicking the Close button in \r
2286 the dialog box is equivalent to clicking on the cancel control. This column is ignored in an Error dialog box. <br />\r
2287 The cancel control is hidden during rollback or the removal of backed up files. The protected UI handler hides the control \r
2288 upon receiving a INSTALLMESSAGE_COMMONDATA message.\r
2289 </term>\r
2290 <term>True</term>\r
2291 </item>\r
2292 </list>\r
2293 <h3>Examples</h3>\r
2294 <example>\r
2295 <para>Add a web folder dialog:</para>\r
2296 <code>\r
2297 <dialogs>\r
2298 <dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" />\r
2299 </dialogs>\r
2300 </code>\r
2301 </example>\r
2302 </summary>\r
2303 </member>\r
2304 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlsElement">\r
2305 <summary>\r
2306 <para>\r
2307 Creates user interface controls displayed on custom dialogs.\r
2308 </para>\r
2309 <h3>Parameters</h3>\r
2310 <list type="table">\r
2311 <listheader>\r
2312 <term>Attribute</term>\r
2313 <term>Type</term>\r
2314 <term>Description</term>\r
2315 <term>Required</term>\r
2316 </listheader>\r
2317 <item>\r
2318 <term>name</term>\r
2319 <term>string</term>\r
2320 <term>Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes.</term>\r
2321 <term>True</term>\r
2322 </item>\r
2323 <item>\r
2324 <term>dialog</term>\r
2325 <term>string</term>\r
2326 <term>Refrence to a dialog. Used to associate the control with the dialog.</term>\r
2327 <term>True</term>\r
2328 </item>\r
2329 <item>\r
2330 <term>type</term>\r
2331 <term>string</term>\r
2332 <term>The type of the control.\r
2333 <list type="table">\r
2334 <listheader>\r
2335 <term>Control name</term>\r
2336 <description>Description</description>\r
2337 </listheader>\r
2338 <item>\r
2339 <term>Billboard</term>\r
2340 <description>Displays billboards based on progress messages.</description>\r
2341 </item>\r
2342 <item>\r
2343 <term>Bitmap</term>\r
2344 <description>Displays a static picture of a bitmap.</description>\r
2345 </item>\r
2346 <item>\r
2347 <term>CheckBox</term>\r
2348 <description>A two-state check box.</description>\r
2349 </item>\r
2350 <item>\r
2351 <term>ComboBox</term>\r
2352 <description>A drop-down list with an edit field.</description>\r
2353 </item>\r
2354 <item>\r
2355 <term>DirectoryCombo</term>\r
2356 <description>Select all except the last segment of the path.</description>\r
2357 </item>\r
2358 <item>\r
2359 <term>DirectoryList</term>\r
2360 <description>Displays folders below the main part of path.</description>\r
2361 </item>\r
2362 <item>\r
2363 <term>Edit</term>\r
2364 <description>A regular edit field for any string or integer.</description>\r
2365 </item>\r
2366 <item>\r
2367 <term>GroupBox</term>\r
2368 <description>Displays a rectangle that groups other controls together.</description>\r
2369 </item>\r
2370 <item>\r
2371 <term>Icon</term>\r
2372 <description>Displays a static picture of an icon.</description>\r
2373 </item>\r
2374 <item>\r
2375 <term>Line</term>\r
2376 <description>Displays a horizontal line.</description>\r
2377 </item>\r
2378 <item>\r
2379 <term>ListBox</term>\r
2380 <description>A drop-down list without an edit field.</description>\r
2381 </item>\r
2382 <item>\r
2383 <term>ListView</term>\r
2384 <description>Displays a column of values with icons for selection.</description>\r
2385 </item>\r
2386 <item>\r
2387 <term>MaskedEdit</term>\r
2388 <description>An edit field with a mask in the text field.</description>\r
2389 </item>\r
2390 <item>\r
2391 <term>PathEdit</term>\r
2392 <description>Displays folder name or entire path in an edit field.</description>\r
2393 </item>\r
2394 <item>\r
2395 <term>ProgressBar</term>\r
2396 <description>Bar graph that changes length as it receives progress messages.</description>\r
2397 </item>\r
2398 <item>\r
2399 <term>PushButton</term>\r
2400 <description>Displays a basic push button.</description>\r
2401 </item>\r
2402 <item>\r
2403 <term>RadioButtonGroup</term>\r
2404 <description>A group of radio buttons.</description>\r
2405 </item>\r
2406 <item>\r
2407 <term>ScrollableText</term>\r
2408 <description>Displays a long string of text.</description>\r
2409 </item>\r
2410 <item>\r
2411 <term>SelectionTree</term>\r
2412 <description>Displays information from the Feature table and enables the user to change their selection state.</description>\r
2413 </item>\r
2414 <item>\r
2415 <term>Text</term>\r
2416 <description>Displays static text.</description>\r
2417 </item>\r
2418 <item>\r
2419 <term>VolumeCostList</term>\r
2420 <description>Displays costing information on different volumes.</description>\r
2421 </item>\r
2422 <item>\r
2423 <term>VolumeSelectCombo</term>\r
2424 <description>Selects volume from an alphabetical list.</description>\r
2425 </item>\r
2426 </list>\r
2427 More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp">http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp</a></term>\r
2428 <term>True</term>\r
2429 </item>\r
2430 <item>\r
2431 <term>x</term>\r
2432 <term>int</term>\r
2433 <term>Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>\r
2434 <term>True</term>\r
2435 </item>\r
2436 <item>\r
2437 <term>y</term>\r
2438 <term>int</term>\r
2439 <term>Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>\r
2440 <term>True</term>\r
2441 </item>\r
2442 <item>\r
2443 <term>width</term>\r
2444 <term>int</term>\r
2445 <term>Width of the rectangular boundary of the control. This must be a non-negative number.</term>\r
2446 <term>True</term>\r
2447 </item>\r
2448 <item>\r
2449 <term>height</term>\r
2450 <term>int</term>\r
2451 <term>Height of the rectangular boundary of the control. This must be a non-negative number.</term>\r
2452 <term>True</term>\r
2453 </item>\r
2454 <item>\r
2455 <term>attr</term>\r
2456 <term>int</term>\r
2457 <term>A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/control_attributes.asp">Control Attributes</a>.</term>\r
2458 <term>True</term>\r
2459 </item>\r
2460 <item>\r
2461 <term>property</term>\r
2462 <term>string</term>\r
2463 <term>The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls.</term>\r
2464 <term>False</term>\r
2465 </item>\r
2466 <item>\r
2467 <term>text</term>\r
2468 <term>string</term>\r
2469 <term>A localizable string used to set the initial text contained in a control. The string can also contain embedded properties.</term>\r
2470 <term>False</term>\r
2471 </item>\r
2472 <item>\r
2473 <term>nextcontrol</term>\r
2474 <term>string</term>\r
2475 <term>The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. </term>\r
2476 <term>False</term>\r
2477 </item>\r
2478 <item>\r
2479 <term>help</term>\r
2480 <term>string</term>\r
2481 <term>Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present.</term>\r
2482 <term>False</term>\r
2483 </item>\r
2484 <item>\r
2485 <term>remove</term>\r
2486 <term>bool</term>\r
2487 <term>If <c>true</c>, the control is removed. If <c>false</c>, the control is added.</term>\r
2488 <term>False</term>\r
2489 </item>\r
2490 </list>\r
2491 <h3>Examples</h3>\r
2492 <example>\r
2493 <para>Remove the Browse button from the customize dialog and add controls for a web dialog</para>\r
2494 <code>\r
2495 <controls>\r
2496 <!-- Remove the Browse button from customize dialog -->\r
2497 <control dialog="CustomizeDlg" name="Browse" type="PushButton"\r
2498 x="304" y="200" width="56" height="17" attr="3" remove="true" />\r
2499 <control dialog="CustomizeDlg" name="Tree" type="SelectionTree"\r
2500 x="25" y="85" width="175" height="95" attr="7" remove="true" />\r
2502 <!-- Re add the tree control with the proper next control -->\r
2503 <control dialog="CustomizeDlg" name="Tree" type="SelectionTree"\r
2504 x="25" y="85" width="175" height="95" attr="7" \r
2505 property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" />\r
2507 <!-- Adds the controls associated with the webfolder dialog -->\r
2508 <control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap" \r
2509 x="0" y="0" width="374" height="44" attr="1" \r
2510 text="[BannerBitmap]" nextcontrol="VDirLabel" />\r
2511 <control dialog="WebFolderDlg" name="Title" type="Text" \r
2512 x="15" y="6" width="200" height="15" attr="196611" \r
2513 text="[DlgTitleFont]Virtual Directory Information" />\r
2514 <control dialog="WebFolderDlg" name="Description" type="Text" \r
2515 x="25" y="23" width="280" height="15" attr="196611" \r
2516 text="Please enter your virtual directory and port information." />\r
2517 <control dialog="WebFolderDlg" name="BannerLine" type="Line" \r
2518 x="0" y="44" width="374" height="0" attr="1" />\r
2519 <control dialog="WebFolderDlg" name="VDirLabel" type="Text" \r
2520 x="18" y="73" width="348" height="15" attr="3" \r
2521 text="&Virtual directory:" \r
2522 nextcontrol="Edit_VDir" /> \r
2523 <control dialog="WebFolderDlg" name="Edit_VDir" type="Edit" \r
2524 x="18" y="85" width="252" height="18" attr="7" \r
2525 property="TARGETVDIR" \r
2526 text="[TARGETVDIR]" \r
2527 nextcontrol="PortLabel" />\r
2528 <control dialog="WebFolderDlg" name="PortLabel" type="Text" \r
2529 x="18" y="110" width="348" height="15" attr="3" \r
2530 text="&Port:" \r
2531 nextcontrol="Edit_Port" /> \r
2532 <control dialog="WebFolderDlg" name="Edit_Port" type="Edit" \r
2533 x="18" y="122" width="48" height="18" attr="7" \r
2534 property="TARGETPORT" \r
2535 text="[TARGETPORT]" \r
2536 nextcontrol="Back" />\r
2537 <control dialog="WebFolderDlg" name="BottomLine" type="Line" \r
2538 x="0" y="234" width="374" height="0" attr="1" /> \r
2539 <control dialog="WebFolderDlg" name="Back" type="PushButton" \r
2540 x="180" y="243" width="56" height="17" attr="3" \r
2541 text="[ButtonText_Back]" nextcontrol="Next" />\r
2542 <control dialog="WebFolderDlg" name="Next" type="PushButton" \r
2543 x="236" y="243" width="56" height="17" attr="3" \r
2544 text="[ButtonText_Next]" nextcontrol="Cancel" />\r
2545 <control dialog="WebFolderDlg" name="Cancel" type="PushButton" \r
2546 x="304" y="243" width="56" height="17" attr="3" \r
2547 text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" />\r
2548 </controls>\r
2549 </code>\r
2550 </example>\r
2551 </summary>\r
2552 </member>\r
2553 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlConditionsElement">\r
2554 <summary>\r
2555 <para>\r
2556 Used to validate and perform operations as the result of information \r
2557 entered by the user into controls on custom dialogs.\r
2558 </para>\r
2559 <h3>Parameters</h3>\r
2560 <list type="table">\r
2561 <listheader>\r
2562 <term>Attribute</term>\r
2563 <term>Type</term>\r
2564 <term>Description</term>\r
2565 <term>Required</term>\r
2566 </listheader>\r
2567 <item>\r
2568 <term>dialog</term>\r
2569 <term>string</term>\r
2570 <term>Refrence to a dialog. Used to associate the control with the dialog.</term>\r
2571 <term>True</term>\r
2572 </item>\r
2573 <item>\r
2574 <term>control</term>\r
2575 <term>string</term>\r
2576 <term>Refrence to a control. Maps to a control for the specified dialog.</term>\r
2577 <term>True</term>\r
2578 </item>\r
2579 <item>\r
2580 <term>action</term>\r
2581 <term>string</term>\r
2582 <term>The action that is to be taken on the control. The possible actions are shown in the following table.\r
2583 <list type="table">\r
2584 <listheader>\r
2585 <term>Value</term>\r
2586 <description>Description</description>\r
2587 </listheader>\r
2588 <item>\r
2589 <term>Default</term>\r
2590 <description>Set control as the default.</description>\r
2591 </item>\r
2592 <item>\r
2593 <term>Disable</term>\r
2594 <description>Disable the control.</description>\r
2595 </item>\r
2596 <item>\r
2597 <term>Enable</term>\r
2598 <description>Enable the control.</description>\r
2599 </item>\r
2600 <item>\r
2601 <term>Hide</term>\r
2602 <description>Hide the control.</description>\r
2603 </item>\r
2604 <item>\r
2605 <term>Show</term>\r
2606 <description>Display the control.</description>\r
2607 </item>\r
2608 </list>\r
2609 </term>\r
2610 <term>True</term>\r
2611 </item>\r
2612 <item>\r
2613 <term>condition</term>\r
2614 <term>string</term>\r
2615 <term>A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. </term>\r
2616 <term>True</term>\r
2617 </item>\r
2618 <item>\r
2619 <term>remove</term>\r
2620 <term>bool</term>\r
2621 <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>\r
2622 <term>False</term>\r
2623 </item>\r
2624 </list>\r
2625 <h3>Examples</h3>\r
2626 <example>\r
2627 <para>Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog</para>\r
2628 <code>\r
2629 <controlconditions>\r
2630 <!-- Remove control condition for Browse button on customizeDlg -->\r
2631 <controlcondition dialog="CustomizeDlg" control="Browse" action="Hide"\r
2632 condition="Installed" remove="true" />\r
2633 <!-- Add control conditions for the web folder dialog -->\r
2634 <controlcondition dialog="WebFolderDlg" control="Back" action="Disable"\r
2635 condition="ShowUserRegistrationDlg=""" />\r
2636 <controlcondition dialog="WebFolderDlg" control="Back" action="Enable"\r
2637 condition="ShowUserRegistrationDlg<>""" />\r
2638 </controlconditions>\r
2639 </code>\r
2640 </example>\r
2641 </summary>\r
2642 </member>\r
2643 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlEventsElement">\r
2644 <summary>\r
2645 <para>\r
2646 Used to route the flow of the installation process as the result of \r
2647 events raised by the user interacting with controls on dialogs.\r
2648 </para>\r
2649 <h3>Parameters</h3>\r
2650 <list type="table">\r
2651 <listheader>\r
2652 <term>Attribute</term>\r
2653 <term>Type</term>\r
2654 <term>Description</term>\r
2655 <term>Required</term>\r
2656 </listheader>\r
2657 <item>\r
2658 <term>dialog</term>\r
2659 <term>string</term>\r
2660 <term>Refrence to a dialog. Used to associate the control with the dialog.</term>\r
2661 <term>True</term>\r
2662 </item>\r
2663 <item>\r
2664 <term>control</term>\r
2665 <term>string</term>\r
2666 <term>Refrence to a control. Maps to a control for the specified dialog.</term>\r
2667 <term>True</term>\r
2668 </item>\r
2669 <item>\r
2670 <term>name</term>\r
2671 <term>string</term>\r
2672 <term>An identifier that specifies the type of event that should take place when the user interacts with the control \r
2673 specified by Dialog_ and Control_. For a list of possible values see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controlevent_overview.asp">ControlEvent Overview</a>. <br/>\r
2674 To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { } \r
2675 into the argument field to enter the null value.\r
2676 </term>\r
2677 <term>True</term>\r
2678 </item>\r
2679 <item>\r
2680 <term>argument</term>\r
2681 <term>string</term>\r
2682 <term>A value used as a modifier when triggering a particular event.</term>\r
2683 <term>True</term>\r
2684 </item>\r
2685 <item>\r
2686 <term>condition</term>\r
2687 <term>string</term>\r
2688 <term>A conditional statement that determines whether the installer activates the event in the Event column. The installer \r
2689 triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column \r
2690 to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains \r
2691 a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no \r
2692 other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field \r
2693 evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field \r
2694 is blank it triggers the one event of these with the largest value in the Ordering field.</term>\r
2695 <term>False</term>\r
2696 </item>\r
2697 <item>\r
2698 <term>order</term>\r
2699 <term>int</term>\r
2700 <term>An integer used to order several events tied to the same control. This must be a non-negative number.</term>\r
2701 <term>False</term>\r
2702 </item>\r
2703 <item>\r
2704 <term>remove</term>\r
2705 <term>bool</term>\r
2706 <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>\r
2707 <term>False</term>\r
2708 </item>\r
2709 </list>\r
2710 <h3>Examples</h3>\r
2711 <example>\r
2712 <para>Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog</para>\r
2713 <code>\r
2714 <!-- Make sure the dialog is put into the execute order -->\r
2715 <controlevents>\r
2716 <!-- Remove the old control events -->\r
2717 <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" \r
2718 argument="SetupTypeDlg" condition="ProductID" remove="true" />\r
2719 <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" \r
2720 argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg <> 1" remove="true" />\r
2721 <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" \r
2722 argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" />\r
2723 <!-- Remove control events for Browse button on CustomizeDlg -->\r
2724 <controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse" \r
2725 argument="BrowseDlg" condition="1" remove="true" /> \r
2727 <!-- Add new control events for the web dialog -->\r
2728 <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" \r
2729 argument="WebFolderDlg" condition="ProductID" /> \r
2730 <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" \r
2731 argument="WebFolderDlg" condition="ShowWebFolderDlg <> 1" />\r
2732 <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" \r
2733 argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" />\r
2734 <controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog" \r
2735 argument="CancelDlg" order="0" />\r
2736 <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" \r
2737 argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg<>1" \r
2738 order="0" />\r
2739 <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" \r
2740 argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1" \r
2741 order="0" />\r
2742 <!-- Virtual Directory Control Events -->\r
2743 <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" \r
2744 argument="WEBCA_CreateURLs" condition="1" order="0" />\r
2745 <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" \r
2746 argument="WEBCA_EvaluateURLsMB" condition="1" order="1" />\r
2747 <controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath" \r
2748 argument="TARGETDIR" condition="1" order="2" />\r
2749 <controlevent dialog="WebFolderDlg" control="Next" name="NewDialog" \r
2750 argument="SetupTypeDlg" condition="1" order="3" />\r
2751 </controlevents>\r
2752 </code>\r
2753 </example>\r
2754 </summary>\r
2755 </member>\r
2756 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerRegistryElement">\r
2757 <summary>\r
2758 <para>\r
2759 Makes modifications to the Windows Registry of the target computer \r
2760 at runtime.\r
2761 </para>\r
2762 <h3>Parameters</h3>\r
2763 <list type="table">\r
2764 <listheader>\r
2765 <term>Attribute</term>\r
2766 <term>Type</term>\r
2767 <term>Description</term>\r
2768 <term>Required</term>\r
2769 </listheader>\r
2770 <item>\r
2771 <term>component</term>\r
2772 <term>string</term>\r
2773 <term>Refrence to a component. The component that controls the installation of the registry value.</term>\r
2774 <term>True</term>\r
2775 </item>\r
2776 <item>\r
2777 <term>root</term>\r
2778 <term>msi:MSIRegistryKeyRoot</term>\r
2779 <term>Valid input: \r
2780 <list type="bullet">\r
2781 <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>\r
2782 <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>\r
2783 <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>\r
2784 <item><c>user</c> represents HKEY_CURRENT_USER</item>\r
2785 <item><c>users</c> represents HKEY_USERS</item>\r
2786 </list>\r
2787 </term>\r
2788 <term>True</term>\r
2789 </item>\r
2790 <item>\r
2791 <term>path</term>\r
2792 <term>string</term>\r
2793 <term>Registry key.</term>\r
2794 <term>True</term>\r
2795 </item>\r
2796 </list>\r
2797 <h3>Nested Elements:</h3>\r
2798 <h4><value></h4>\r
2799 <ul>\r
2800 Specifies the registry value to add to the target machine.\r
2801 <list type="table">\r
2802 <listheader>\r
2803 <term>Attribute</term>\r
2804 <term>Type</term>\r
2805 <term>Description</term>\r
2806 <term>Required</term>\r
2807 </listheader>\r
2808 <item>\r
2809 <term>name</term>\r
2810 <term>string</term>\r
2811 <term>The registry value name (localizable). If this is Null, then the data entered into the Value column are \r
2812 written to the default registry key. <br/>\r
2813 If the Value column is Null, then the strings shown in the following table in the Name column have special \r
2814 significance.\r
2815 <list type="table">\r
2816 <listheader>\r
2817 <term>String</term>\r
2818 <description>Description</description>\r
2819 </listheader>\r
2820 <item>\r
2821 <term>+</term>\r
2822 <description>The key is to be created, if absent, when the component is installed.</description>\r
2823 </item>\r
2824 <item>\r
2825 <term>-</term>\r
2826 <description>The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>\r
2827 </item>\r
2828 <item>\r
2829 <term>*</term>\r
2830 <description>The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>\r
2831 </item>\r
2832 </list>\r
2833 </term>\r
2834 <term>False</term>\r
2835 </item>\r
2836 <item>\r
2837 <term>value</term>\r
2838 <term>string</term>\r
2839 <term>The localizable registry value. The field is <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">Formatted</a>. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string. \r
2840 <list type="table">\r
2841 <listheader>\r
2842 <term>Prefix</term>\r
2843 <description>Description</description>\r
2844 </listheader>\r
2845 <item>\r
2846 <term>#x</term>\r
2847 <description>The value is interpreted and stored as a hexadecimal value (REG_BINARY).</description>\r
2848 </item>\r
2849 <item>\r
2850 <term>#%</term>\r
2851 <description>The value is interpreted and stored as an expandable string (REG_EXPAND_SZ).</description>\r
2852 </item>\r
2853 <item>\r
2854 <term>#</term>\r
2855 <description>The value is interpreted and stored as an integer (REG_DWORD).</description>\r
2856 </item>\r
2857 </list>\r
2858 <list type="bullet">\r
2859 <item>If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." </item>\r
2860 <item>The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character.</item>\r
2861 <item>If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed.</item>\r
2862 <item>If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed.</item>\r
2863 <item>If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings.</item>\r
2864 <item>Otherwise, the value is interpreted and stored as a string (REG_SZ). </item>\r
2865 </list>\r
2866 </term>\r
2867 <term>False</term>\r
2868 </item>\r
2869 <item>\r
2870 <term>dword</term>\r
2871 <term>string</term>\r
2872 <term>A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value.</term>\r
2873 <term>False</term>\r
2874 </item>\r
2875 <item>\r
2876 <term>id</term>\r
2877 <term>string</term>\r
2878 <term>Primary key used to identify a registry record.</term>\r
2879 <term>False</term>\r
2880 </item>\r
2881 </list>\r
2882 </ul>\r
2883 <h4></value></h4>\r
2884 <h3>Examples</h3>\r
2885 <example>\r
2886 <para>Add the a couple registry entries on the target machine.</para>\r
2887 <code>\r
2888 <registry>\r
2889 <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" >\r
2890 <value name="ProductVersion" value="1.0.0" />\r
2891 <value name="ProductDir" value="[TARGETDIR]" />\r
2892 <value name="VirtualDir" value="[TARGETVDIR]" />\r
2893 </key>\r
2894 </registry>\r
2895 </code>\r
2896 </example>\r
2897 <example>\r
2898 <para>Add a default key value to the specified registry key path</para>\r
2899 <code>\r
2900 <registry>\r
2901 <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" >\r
2902 <value value="1.0.0" />\r
2903 </key>\r
2904 </registry>\r
2905 </code>\r
2906 </example>\r
2907 <example>\r
2908 <para>Another way to add a default key value to the specified registry key path</para>\r
2909 <code>\r
2910 <registry>\r
2911 <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" >\r
2912 <value name="" value="1.0.0" />\r
2913 </key>\r
2914 </registry>\r
2915 </code>\r
2916 </example>\r
2917 <example>\r
2918 <para>Specify hexadecimal value (REG_BINARY) for the default key</para>\r
2919 <code>\r
2920 <registry>\r
2921 <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" >\r
2922 <value>\r
2923 1a,81,0a,03,01,00,06,00,00,00,d3,15,fd,00,01,00,00,00,00,00,01,\r
2924 00,00,00,00,00,00,00,00,00,00,00,b0,90,ce,09,01,00,00,00,00,00,ff,ff,ff,00,\r
2925 00,00,00,00,00,00,00,00,6d,7a,0a,03,01,00,00,00,00,00,00,00,38,40,00,00,00,\r
2926 00,00,00,00,00,00,00,00,00,90,01,00,00,00,00,00,01,00,00,00,00,0f,00,00,00,\r
2927 f0,ff,ff,ff,54,69,6d,65,73,20,4e,65,77,20,52,6f,6d,61,6e,f4,6f,d4,08,02,00\r
2928 </value>\r
2929 </key>\r
2930 </registry>\r
2931 </code>\r
2932 </example>\r
2933 </summary>\r
2934 </member>\r
2935 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIconsElement">\r
2936 <summary>\r
2937 <para>\r
2938 Stores icons to be used with shortcuts, file extensions, CLSIDs or \r
2939 similar uses.\r
2940 </para>\r
2941 <h3>Parameters</h3>\r
2942 <list type="table">\r
2943 <listheader>\r
2944 <term>Attribute</term>\r
2945 <term>Type</term>\r
2946 <term>Description</term>\r
2947 <term>Required</term>\r
2948 </listheader>\r
2949 <item>\r
2950 <term>name</term>\r
2951 <term>string</term>\r
2952 <term>Name of the icon file.</term>\r
2953 <term>True</term>\r
2954 </item>\r
2955 <item>\r
2956 <term>value</term>\r
2957 <term>string</term>\r
2958 <term>The binary icon data in PE (.dll or .exe) or icon (.ico) format.</term>\r
2959 <term>True</term>\r
2960 </item>\r
2961 </list>\r
2962 <h3>Examples</h3>\r
2963 <example>\r
2964 <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>\r
2965 <code>\r
2966 <icons>\r
2967 <icon name="CHMICON" value="${resource.dir}\chm.ico" />\r
2968 </icons>\r
2969 </code>\r
2970 </example>\r
2971 </summary>\r
2972 </member>\r
2973 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerShortcutsElement">\r
2974 <summary>\r
2975 <para>\r
2976 Creates shortcuts on the target computer.\r
2977 </para>\r
2978 <h3>Parameters</h3>\r
2979 <list type="table">\r
2980 <listheader>\r
2981 <term>Attribute</term>\r
2982 <term>Type</term>\r
2983 <term>Description</term>\r
2984 <term>Required</term>\r
2985 </listheader>\r
2986 <item>\r
2987 <term>name</term>\r
2988 <term>string</term>\r
2989 <term>Unique name identifying the shortcut.</term>\r
2990 <term>True</term>\r
2991 </item>\r
2992 <item>\r
2993 <term>directory</term>\r
2994 <term>string</term>\r
2995 <term>Reference to a directory. The location of where the shortcut should be created.</term>\r
2996 <term>True</term>\r
2997 </item>\r
2998 <item>\r
2999 <term>filename</term>\r
3000 <term>string</term>\r
3001 <term>The localizable name of the shortcut to be created.</term>\r
3002 <term>True</term>\r
3003 </item>\r
3004 <item>\r
3005 <term>component</term>\r
3006 <term>string</term>\r
3007 <term>Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. </term>\r
3008 <term>True</term>\r
3009 </item>\r
3010 <item>\r
3011 <term>target</term>\r
3012 <term>string</term>\r
3013 <term>The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut.</term>\r
3014 <term>True</term>\r
3015 </item>\r
3016 <item>\r
3017 <term>arguments</term>\r
3018 <term>string</term>\r
3019 <term>The command-line arguments for the shortcut. <br/>Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut.\r
3020 </term>\r
3021 <term>False</term>\r
3022 </item>\r
3023 <item>\r
3024 <term>hotkey</term>\r
3025 <term>string</term>\r
3026 <term>The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility.</term>\r
3027 <term>False</term>\r
3028 </item>\r
3029 <item>\r
3030 <term>icon</term>\r
3031 <term>string</term>\r
3032 <term>Reference to an icon. </term>\r
3033 <term>False</term>\r
3034 </item>\r
3035 <item>\r
3036 <term>iconindex</term>\r
3037 <term>int</term>\r
3038 <term>The icon index for the shortcut. This must be a non-negative number.</term>\r
3039 <term>False</term>\r
3040 </item>\r
3041 <item>\r
3042 <term>showcmd</term>\r
3043 <term>int</term>\r
3044 <term>The Show command for the application window. <br/>The following values may be used. The values are as defined for the Windows API function ShowWindow.\r
3045 <list type="table">\r
3046 <listheader>\r
3047 <term>Value</term>\r
3048 <description>Description</description>\r
3049 </listheader>\r
3050 <item>\r
3051 <term>1</term>\r
3052 <description>SW_SHOWNORMAL</description>\r
3053 </item>\r
3054 <item>\r
3055 <term>3</term>\r
3056 <description>SW_SHOWMAXIMIZED</description>\r
3057 </item>\r
3058 <item>\r
3059 <term>7</term>\r
3060 <description>SW_SHOWMINNOACTIVE</description>\r
3061 </item>\r
3062 </list>\r
3063 </term>\r
3064 <term>False</term>\r
3065 </item>\r
3066 <item>\r
3067 <term>wkdir</term>\r
3068 <term>string</term>\r
3069 <term>The name of the property that has the path of the working directory for the shortcut.</term>\r
3070 <term>False</term>\r
3071 </item>\r
3072 </list>\r
3073 <h3>Nested Elements:</h3>\r
3074 <h4><description></h4>\r
3075 <ul>\r
3076 The localizable description of the shortcut. \r
3077 </ul>\r
3078 <h4></description></h4>\r
3079 <h3>Examples</h3>\r
3080 <example>\r
3081 <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>\r
3082 <code>\r
3083 <shortcuts>\r
3084 <shortcut name="HelpFiles" directory="D__PROGRAMMENU_ACME_MYPRODUCT" filename="Help File" component="C__MainFiles" target="[$C__MainFiles]\Help.chm" icon="CHMICON" iconindex="0" showcmd="3" >\r
3085 <description>My Product help documentation</description>\r
3086 </shortcut>\r
3087 </shortcuts>\r
3088 </code>\r
3089 </example>\r
3090 </summary>\r
3091 </member>\r
3092 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerBinariesElement">\r
3093 <summary>\r
3094 <para>\r
3095 Stores the binary data for items such as bitmaps, animations, and \r
3096 icons. The binary table is also used to store data for custom \r
3097 actions.\r
3098 </para>\r
3099 <h3>Parameters</h3>\r
3100 <list type="table">\r
3101 <listheader>\r
3102 <term>Attribute</term>\r
3103 <term>Type</term>\r
3104 <term>Description</term>\r
3105 <term>Required</term>\r
3106 </listheader>\r
3107 <item>\r
3108 <term>name</term>\r
3109 <term>string</term>\r
3110 <term>A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data.</term>\r
3111 <term>True</term>\r
3112 </item>\r
3113 <item>\r
3114 <term>value</term>\r
3115 <term>string</term>\r
3116 <term>The binary file to add.</term>\r
3117 <term>True</term>\r
3118 </item>\r
3119 </list>\r
3120 <h3>Examples</h3>\r
3121 <example>\r
3122 <para>Add the custom action dll to create/modify virtual directories</para>\r
3123 <code>\r
3124 <binaries>\r
3125 <binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" />\r
3126 </binaries>\r
3127 </code>\r
3128 </example>\r
3129 </summary>\r
3130 </member>\r
3131 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerCustomActionsElement">\r
3132 <summary>\r
3133 <para>\r
3134 Used to configure executables that may be run during steps in the \r
3135 installation process to do things outside the bounds of MSI \r
3136 technology's feature set. This is the main spot you can extend MSI \r
3137 technology to perform custom processes via compiled code.\r
3138 </para>\r
3139 <h3>Parameters</h3>\r
3140 <list type="table">\r
3141 <listheader>\r
3142 <term>Attribute</term>\r
3143 <term>Type</term>\r
3144 <term>Description</term>\r
3145 <term>Required</term>\r
3146 </listheader>\r
3147 <item>\r
3148 <term>action</term>\r
3149 <term>string</term>\r
3150 <term>Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. </term>\r
3151 <term>True</term>\r
3152 </item>\r
3153 <item>\r
3154 <term>type</term>\r
3155 <term>string</term>\r
3156 <term>A field of flag bits specifying the basic type of custom action and options. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a> for a list of the basic types. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_return_processing_options.asp">Custom Action Return Processing Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_execution_scheduling_options.asp">Custom Action Execution Scheduling Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_hidden_target_option.asp">Custom Action Hidden Target Option</a>, and <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_in_script_execution_options.asp">Custom Action In-Script Execution Options</a>. </term>\r
3157 <term>True</term>\r
3158 </item>\r
3159 <item>\r
3160 <term>source</term>\r
3161 <term>string</term>\r
3162 <term>A property name or external key into another table. For a discussion of the possible custom action sources, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_sources.asp">Custom Action Sources</a> and the <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a>. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code. <br/>\r
3163 Directory table for calling existing executables.<br/>\r
3164 File table for calling executables and DLLs that have just been installed.<br/>\r
3165 Binary table for calling executables, DLLs, and data stored in the database.<br/>\r
3166 Property table for calling executables whose paths are held by a property.\r
3167 </term>\r
3168 <term>True</term>\r
3169 </item>\r
3170 <item>\r
3171 <term>target</term>\r
3172 <term>string</term>\r
3173 <term>An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action. \r
3174 <list type="table">\r
3175 <listheader>\r
3176 <term>Target</term>\r
3177 <term>Custom Action</term>\r
3178 </listheader>\r
3179 <item>\r
3180 <term>Entry point (required)</term>\r
3181 <term>Calling a DLL.</term>\r
3182 </item>\r
3183 <item>\r
3184 <term>Executable name with arguments (required)</term>\r
3185 <term>Calling an existing executable.</term>\r
3186 </item>\r
3187 <item>\r
3188 <term>Command line arguments (optional)</term>\r
3189 <term>Calling an executable just installed.</term>\r
3190 </item>\r
3191 <item>\r
3192 <term>Target file name (required)</term>\r
3193 <term>Creating a file from custom data.</term>\r
3194 </item>\r
3195 <item>\r
3196 <term>Null</term>\r
3197 <term>Executing script code.</term>\r
3198 </item>\r
3199 </list>\r
3200 </term>\r
3201 <term>True</term>\r
3202 </item>\r
3203 </list>\r
3204 <h3>Examples</h3>\r
3205 <example>\r
3206 <para>Add some custom actions related to the virtual directory dialog and custom action.</para>\r
3207 <code>\r
3208 <customactions>\r
3209 <!-- Custom actions creating entry points into the custom action dll specified in the binary table -->\r
3210 <customaction action="WEBCA_GatherWebFolderProperties" type="1" source="MSVBDPCADLL" target="GatherWebFolderProperties" />\r
3211 <customaction action="WEBCA_ApplyWebFolderProperties" type="1537" source="MSVBDPCADLL" target="ApplyWebFolderProperties" />\r
3212 <customaction action="WEBCA_RollbackApplyWebFolderProperties" type="1281" source="MSVBDPCADLL" target="RollbackApplyWebFolderProperties" />\r
3213 <customaction action="WEBCA_CreateURLs" type="1" source="MSVBDPCADLL" target="CreateURLs" />\r
3214 <customaction action="WEBCA_EvaluateURLs" type="1" source="MSVBDPCADLL" target="EvaluateURLs" />\r
3215 <customaction action="WEBCA_EvaluateURLsNoFail" type="1" source="MSVBDPCADLL" target="EvaluateURLsNoFail" />\r
3216 <customaction action="WEBCA_EvaluateURLsMB" type="1" source="MSVBDPCADLL" target="EvaluateURLsMB" />\r
3217 <customaction action="WEBCA_CreateAppRoots" type="1" source="MSVBDPCADLL" target="CreateAppRoots" />\r
3218 \r
3219 <!-- Custom actions to set default control values in the webfolder dialog -->\r
3220 <customaction action="WEBCA_TARGETVDIR" type="307" source="TARGETVDIR" target="Default VDir" />\r
3221 <customaction action="WEBCA_TARGETPORT" type="307" source="TARGETPORT" target="80" />\r
3222 </customactions>\r
3223 </code>\r
3224 </example>\r
3225 </summary>\r
3226 </member>\r
3227 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSequencesElement">\r
3228 <summary>\r
3229 <para>\r
3230 Used to modify the sequence of tasks/events that execute during the \r
3231 overall installation process.\r
3232 </para>\r
3233 <h3>Parameters</h3>\r
3234 <list type="table">\r
3235 <listheader>\r
3236 <term>Attribute</term>\r
3237 <term>Type</term>\r
3238 <term>Description</term>\r
3239 <term>Required</term>\r
3240 </listheader>\r
3241 <item>\r
3242 <term>type</term>\r
3243 <term>msi:MSISequenceTable</term>\r
3244 <term>Valid inputs:\r
3245 <list type="bullet">\r
3246 <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installexecutesequence_table.asp">InstallExecuteSequence Table</a>.</item>\r
3247 <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installuisequence_table.asp">InstallUISequence Table</a></item>\r
3248 <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminexecutesequence_table.asp">AdminExecuteSequence Table</a></item>\r
3249 <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminuisequence_table.asp">AdminUISequence Table</a></item>\r
3250 <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/advtuisequence_table.asp">AdvtUISequence Table</a></item>\r
3251 </list>\r
3252 </term>\r
3253 <term>True</term>\r
3254 </item>\r
3255 <item>\r
3256 <term>action</term>\r
3257 <term>string</term>\r
3258 <term>Name of the action to execute. This is either a built-in action or a custom action.</term>\r
3259 <term>True</term>\r
3260 </item>\r
3261 <item>\r
3262 <term>value</term>\r
3263 <term>int</term>\r
3264 <term>Number that determines the sequence position in which this action is to be executed. <br/>\r
3265 A positive value represents the sequence position. A Null value indicates that the action is not executed. The following \r
3266 negative values indicate that this action is to be executed if the installer returns the associated termination flag. No \r
3267 more than one action may have a negative value entered in the Sequence field.\r
3268 <list type="table">\r
3269 <listheader>\r
3270 <term>Value</term>\r
3271 <description>Description</description>\r
3272 </listheader>\r
3273 <item>\r
3274 <term>-1</term>\r
3275 <description>Successful completion.</description>\r
3276 </item>\r
3277 <item>\r
3278 <term>-2</term>\r
3279 <description>User terminates install.</description>\r
3280 </item>\r
3281 <item>\r
3282 <term>-3</term>\r
3283 <description>Fatal exit terminates.</description>\r
3284 </item>\r
3285 <item>\r
3286 <term>-4</term>\r
3287 <description>Install is suspended.</description>\r
3288 </item>\r
3289 </list>\r
3290 </term>\r
3291 <term>True</term>\r
3292 </item>\r
3293 <item>\r
3294 <term>condition</term>\r
3295 <term>string</term>\r
3296 <term>This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. </term>\r
3297 <term>False</term>\r
3298 </item>\r
3299 </list>\r
3300 <h3>Examples</h3>\r
3301 <example>\r
3302 <para>Add the sequences to support virtual directories</para>\r
3303 <code>\r
3304 <sequences>\r
3305 <sequence type="installexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" />\r
3306 <sequence type="installexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> \r
3307 <sequence type="installexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" />\r
3308 <sequence type="installexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" />\r
3309 <sequence type="installexecute" action="WEBCA_GatherWebFolderProperties" value="3701" condition="NOT Installed" />\r
3310 <sequence type="installexecute" action="WEBCA_ApplyWebFolderProperties" value="3701" condition="NOT Installed" />\r
3311 <sequence type="installexecute" action="WEBCA_RollbackApplyWebFolderProperties" value="3701" condition="NOT Installed" />\r
3312 <sequence type="installexecute" action="WEBCA_CreateAppRoots" value="3701" condition="NOT Installed" />\r
3313 <sequence type="installui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" />\r
3314 <sequence type="installui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" />\r
3315 <sequence type="installui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" />\r
3316 <sequence type="installui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" />\r
3317 <sequence type="adminexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" />\r
3318 <sequence type="adminexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" />\r
3319 <sequence type="adminexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" />\r
3320 <sequence type="adminexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" />\r
3321 <sequence type="adminui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" />\r
3322 <sequence type="adminui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" />\r
3323 <sequence type="adminui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" />\r
3324 <sequence type="adminui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> \r
3325 </sequences>\r
3326 </code>\r
3327 </example>\r
3328 </summary>\r
3329 </member>\r
3330 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerActionTextElement">\r
3331 <summary>\r
3332 <para>\r
3333 Creates text to be displayed in a progress dialog box and written \r
3334 to the log for actions that take a long time to execute. The text \r
3335 displayed consists of the action description and optionally formatted \r
3336 data from the action. The entries in the ActionText table typically \r
3337 refer to actions in sequence tables.\r
3338 </para>\r
3339 <h3>Parameters</h3>\r
3340 <list type="table">\r
3341 <listheader>\r
3342 <term>Attribute</term>\r
3343 <term>Type</term>\r
3344 <term>Description</term>\r
3345 <term>Required</term>\r
3346 </listheader>\r
3347 <item>\r
3348 <term>name</term>\r
3349 <term>string</term>\r
3350 <term>Unique name identifying the action.</term>\r
3351 <term>True</term>\r
3352 </item>\r
3353 <item>\r
3354 <term>template</term>\r
3355 <term>string</term>\r
3356 <term>A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed.</term>\r
3357 <term>False</term>\r
3358 </item>\r
3359 </list>\r
3360 <h3>Nested Elements:</h3>\r
3361 <h4><description></h4>\r
3362 <ul>\r
3363 Localized description displayed in the progress dialog box or written to the log when the action is executing. \r
3364 </ul>\r
3365 <h4></description></h4>\r
3366 <h3>Examples</h3>\r
3367 <example>\r
3368 <para>Add the related action text for the web folder actions.</para>\r
3369 <code>\r
3370 <actiontext>\r
3371 <action name="WEBCA_GatherWebFolderProperties" >\r
3372 <description>Gathering web folder properties</description>\r
3373 </action>\r
3374 <action name="WEBCA_ApplyWebFolderProperties" >\r
3375 <description>Applying web folder properties</description>\r
3376 </action>\r
3377 <action name="WEBCA_RollbackApplyWebFolderProperties" >\r
3378 <description>Removing web folder properties</description>\r
3379 </action>\r
3380 <action name="WEBCA_CreateURLs" >\r
3381 <description>Creating URLs</description>\r
3382 </action>\r
3383 <action name="WEBCA_EvaluateURLs" >\r
3384 <description>Evaluating URLs</description>\r
3385 </action>\r
3386 <action name="WEBCA_EvaluateURLsNoFail" >\r
3387 <description>Evaluating URLs and do not fail if URL is invalid</description>\r
3388 </action>\r
3389 <action name="WEBCA_EvaluateURLsMB" >\r
3390 <description>Evaluating URLs</description>\r
3391 </action>\r
3392 <action name="WEBCA_CreateAppRoots" >\r
3393 <description>Creating application roots</description>\r
3394 </action>\r
3395 <action name="WEBCA_TARGETVDIR" >\r
3396 <description>Set TARGETVDIR property to the specified virtual dir</description>\r
3397 </action>\r
3398 <action name="WEBCA_TARGETPORT" >\r
3399 <description>Set TARGETPORT property to the specified virtual dir port</description>\r
3400 </action>\r
3401 </actiontext>\r
3402 </code>\r
3403 </example>\r
3404 </summary>\r
3405 </member>\r
3406 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppMappingsElement">\r
3407 <summary>\r
3408 <para>\r
3409 Adds Verbs and a handler for the specified file type.\r
3410 </para>\r
3411 <note>This not an officially Microsoft supported table.</note>\r
3412 <h3>Parameters</h3>\r
3413 <list type="table">\r
3414 <listheader>\r
3415 <term>Attribute</term>\r
3416 <term>Type</term>\r
3417 <term>Description</term>\r
3418 <term>Required</term>\r
3419 </listheader>\r
3420 <item>\r
3421 <term>directory</term>\r
3422 <term>string</term>\r
3423 <term>Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type.</term>\r
3424 <term>True</term>\r
3425 </item>\r
3426 <item>\r
3427 <term>extension</term>\r
3428 <term>string</term>\r
3429 <term>File name extension to specifically handle</term>\r
3430 <term>False</term>\r
3431 </item>\r
3432 <item>\r
3433 <term>exepath</term>\r
3434 <term>string</term>\r
3435 <term>Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request.</term>\r
3436 <term>False</term>\r
3437 </item>\r
3438 <item>\r
3439 <term>verbs</term>\r
3440 <term>string</term>\r
3441 <term>Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed.</term>\r
3442 <term>False</term>\r
3443 </item>\r
3444 </list>\r
3445 <h3>Examples</h3>\r
3446 <example>\r
3447 <para>Add the aspx app mapping</para>\r
3448 <code>\r
3449 <appmappings>\r
3450 <appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" />\r
3451 </appmappings>\r
3452 </code>\r
3453 </example>\r
3454 </summary>\r
3455 </member>\r
3456 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerUrlPropertiesElement">\r
3457 <summary>\r
3458 <para>\r
3459 Determines the local path equivalent for a url and stores this \r
3460 information in a property.\r
3461 </para>\r
3462 <note>This not an officially Microsoft supported table.</note>\r
3463 <h3>Parameters</h3>\r
3464 <list type="table">\r
3465 <listheader>\r
3466 <term>Attribute</term>\r
3467 <term>Type</term>\r
3468 <term>Description</term>\r
3469 <term>Required</term>\r
3470 </listheader>\r
3471 <item>\r
3472 <term>name</term>\r
3473 <term>string</term>\r
3474 <term>The name of the URLProperty to convert</term>\r
3475 <term>True</term>\r
3476 </item>\r
3477 <item>\r
3478 <term>property</term>\r
3479 <term>string</term>\r
3480 <term>The name of the property to store the directory information.</term>\r
3481 <term>True</term>\r
3482 </item>\r
3483 </list>\r
3484 <h3>Examples</h3>\r
3485 <example>\r
3486 <para>Convert the TARGETURL property to a directory and store that information in TARGETDIR</para>\r
3487 <code>\r
3488 <urlproperties>\r
3489 <urlproperty name="TARGETURL" property="TARGETDIR" />\r
3490 </urlproperties>\r
3491 </code>\r
3492 </example>\r
3493 </summary>\r
3494 </member>\r
3495 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerVDirPropertiesElement">\r
3496 <summary>\r
3497 <para>\r
3498 Creates a URLProperty representing the virtual directory and port.\r
3499 </para>\r
3500 <note>This not an officially Microsoft supported table.</note>\r
3501 <h3>Parameters</h3>\r
3502 <list type="table">\r
3503 <listheader>\r
3504 <term>Attribute</term>\r
3505 <term>Type</term>\r
3506 <term>Description</term>\r
3507 <term>Required</term>\r
3508 </listheader>\r
3509 <item>\r
3510 <term>name</term>\r
3511 <term>string</term>\r
3512 <term>Property containing the virtual directory</term>\r
3513 <term>True</term>\r
3514 </item>\r
3515 <item>\r
3516 <term>portproperty</term>\r
3517 <term>string</term>\r
3518 <term>Property containing the network port number to use.</term>\r
3519 <term>True</term>\r
3520 </item>\r
3521 <item>\r
3522 <term>urlproperty</term>\r
3523 <term>string</term>\r
3524 <term>URLProperty to store the url in</term>\r
3525 <term>True</term>\r
3526 </item>\r
3527 </list>\r
3528 <h3>Examples</h3>\r
3529 <example>\r
3530 <para>Convert the virtual directory and port to a url and store the value in a property.</para>\r
3531 <code>\r
3532 <vdirproperties>\r
3533 <vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" />\r
3534 </vdirproperties>\r
3535 </code>\r
3536 </example>\r
3537 </summary>\r
3538 </member>\r
3539 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppRootsElement">\r
3540 <summary>\r
3541 <para>\r
3542 Create a Web application definition and marks it as running in-process \r
3543 or out-of-process. If an application already exists at the specified \r
3544 path, you can use this method to reconfigure the application from \r
3545 in-process to out-of-process, or the reverse.\r
3546 </para>\r
3547 <note>This not an officially Microsoft supported table.</note>\r
3548 <h3>Parameters</h3>\r
3549 <list type="table">\r
3550 <listheader>\r
3551 <term>Attribute</term>\r
3552 <term>Type</term>\r
3553 <term>Description</term>\r
3554 <term>Required</term>\r
3555 </listheader>\r
3556 <item>\r
3557 <term>component</term>\r
3558 <term>string</term>\r
3559 <term>Reference to a component. Determines when the approot will be created.</term>\r
3560 <term>True</term>\r
3561 </item>\r
3562 <item>\r
3563 <term>urlproperty</term>\r
3564 <term>string</term>\r
3565 <term>URLProperty with stored url</term>\r
3566 <term>True</term>\r
3567 </item>\r
3568 <item>\r
3569 <term>inprocflag</term>\r
3570 <term>int</term>\r
3571 <term>Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space.</term>\r
3572 <term>True</term>\r
3573 </item>\r
3574 </list>\r
3575 <h3>Examples</h3>\r
3576 <example>\r
3577 <para>Convert the virtual directory and port to a url and store the value in a property.</para>\r
3578 <code>\r
3579 <approots>\r
3580 <approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" />\r
3581 </approots>\r
3582 </code>\r
3583 </example>\r
3584 </summary>\r
3585 </member>\r
3586 <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIISPropertiesElement">\r
3587 <summary>\r
3588 <para>\r
3589 Specifies directory security in IIS. Can also configure the default \r
3590 documents supported by each directory.\r
3591 </para>\r
3592 <note>This not an officially Microsoft supported table.</note>\r
3593 <h3>Parameters</h3>\r
3594 <list type="table">\r
3595 <listheader>\r
3596 <term>Attribute</term>\r
3597 <term>Type</term>\r
3598 <term>Description</term>\r
3599 <term>Required</term>\r
3600 </listheader>\r
3601 <item>\r
3602 <term>directory</term>\r
3603 <term>string</term>\r
3604 <term>Reference to a directory. This is the directory that gets modified with the specific attributes.</term>\r
3605 <term>True</term>\r
3606 </item>\r
3607 <item>\r
3608 <term>attr</term>\r
3609 <term>int</term>\r
3610 <term>Attributes to set for the directory.\r
3611 <list type="table">\r
3612 <listheader>\r
3613 <term>Value</term>\r
3614 <term>Flag Name</term>\r
3615 <description>Description</description>\r
3616 </listheader>\r
3617 <item>\r
3618 <term>1</term>\r
3619 <term>AccessRead</term>\r
3620 <description>The file or the contents of the folder may be read through Microsoft Internet Explorer.</description>\r
3621 </item>\r
3622 <item>\r
3623 <term>2</term>\r
3624 <term>AccessWrite</term>\r
3625 <description>Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard.</description>\r
3626 </item>\r
3627 <item>\r
3628 <term>4</term>\r
3629 <term>AccessExecute</term>\r
3630 <description>The file or the contents of the folder may be executed, regardless of file type.</description>\r
3631 </item>\r
3632 <item>\r
3633 <term>8</term>\r
3634 <term>AccessSSL</term>\r
3635 <description>File access requires SSL file permission processing, with or without a client certificate.</description>\r
3636 </item>\r
3637 <item>\r
3638 <term>16</term>\r
3639 <term>AccessSource</term>\r
3640 <description>Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications.</description>\r
3641 </item>\r
3642 <item>\r
3643 <term>32</term>\r
3644 <term>AccessSSLNegotiateCert</term>\r
3645 <description>SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true).</description>\r
3646 </item>\r
3647 <item>\r
3648 <term>64</term>\r
3649 <term>AccessSSLRequireCert</term>\r
3650 <description>SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert.</description>\r
3651 </item>\r
3652 <item>\r
3653 <term>128</term>\r
3654 <term>AccessSSLMapCert</term>\r
3655 <description>SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur.</description>\r
3656 </item>\r
3657 <item>\r
3658 <term>256</term>\r
3659 <term>AccessSSL128</term>\r
3660 <description>File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate.</description>\r
3661 </item>\r
3662 <item>\r
3663 <term>512</term>\r
3664 <term>AccessScript</term>\r
3665 <description>The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served.</description>\r
3666 </item>\r
3667 <item>\r
3668 <term>1024</term>\r
3669 <term>AccessNoRemoteWrite</term>\r
3670 <description>Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests.</description>\r
3671 </item>\r
3672 <item>\r
3673 <term>4096</term>\r
3674 <term>AccessNoRemoteRead</term>\r
3675 <description>Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests.</description>\r
3676 </item>\r
3677 <item>\r
3678 <term>8192</term>\r
3679 <term>AccessNoRemoteExecute</term>\r
3680 <description>Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests.</description>\r
3681 </item>\r
3682 <item>\r
3683 <term>16384</term>\r
3684 <term>AccessNoRemoteScript</term>\r
3685 <description>Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests.</description>\r
3686 </item>\r
3687 <item>\r
3688 <term>32768</term>\r
3689 <term>AccessNoPhysicalDir</term>\r
3690 <description>Access to the physical path is not allowed.</description>\r
3691 </item>\r
3692 </list>\r
3693 </term>\r
3694 <term>True</term>\r
3695 </item>\r
3696 <item>\r
3697 <term>defaultdoc</term>\r
3698 <term>string</term>\r
3699 <term>Adds a filename to the <a href="http://msdn.microsoft.com/library/en-us/iissdk/iis/ref_mb_defaultdoc.asp">Default Documents</a> to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm")</term>\r
3700 <term>False</term>\r
3701 </item>\r
3702 </list>\r
3703 <h3>Examples</h3>\r
3704 <example>\r
3705 <para>Specify permissions for the directory structure.</para>\r
3706 <code>\r
3707 <iisproperties>\r
3708 <iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" />\r
3709 <iisproperty directory="D__BIN" attr="112" />\r
3710 <iisproperty directory="D__SomeSubDir" attr="114" />\r
3711 </iisproperties>\r
3712 </code>\r
3713 </example>\r
3714 </summary>\r
3715 </member>\r
3716 <member name="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand">\r
3717 <summary>\r
3718 Summary description for MsiTaskInfo.\r
3719 </summary>\r
3720 </member>\r
3721 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBannerImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
3722 <summary>\r
3723 Loads the banner image.\r
3724 </summary>\r
3725 <param name="database">The MSI database.</param>\r
3726 </member>\r
3727 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBackgroundImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
3728 <summary>\r
3729 Loads the background image.\r
3730 </summary>\r
3731 <param name="database">The MSI database.</param>\r
3732 </member>\r
3733 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLicense(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
3734 <summary>\r
3735 Loads the license file.\r
3736 </summary>\r
3737 <param name="database">The MSI database.</param>\r
3738 </member>\r
3739 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMedia(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32)">\r
3740 <summary>\r
3741 Loads records for the Media table.\r
3742 </summary>\r
3743 <param name="database">The MSI database.</param>\r
3744 <param name="LastSequence">The sequence number of the last file in the .cab.</param>\r
3745 </member>\r
3746 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadFeatures(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
3747 <summary>\r
3748 Loads records for the Features table.\r
3749 </summary>\r
3750 <param name="database">The MSI database.</param>\r
3751 </member>\r
3752 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.AddFeature(NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Schemas.Msi.MSIFeature,System.Int32,System.Int32)">\r
3753 <summary>\r
3754 Adds a feature record to the Features table.\r
3755 </summary>\r
3756 <param name="featureTable">The MSI database Feature table.</param>\r
3757 <param name="conditionTable">The MSI database Condition table.</param>\r
3758 <param name="ParentFeature">The name of this feature's parent.</param>\r
3759 <param name="database">The MSI database.</param>\r
3760 <param name="Feature">This Feature's Schema element.</param>\r
3761 <param name="Depth">The tree depth of this feature.</param>\r
3762 <param name="Order">The tree order of this feature.</param>\r
3763 </member>\r
3764 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLaunchCondition(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
3765 <summary>\r
3766 Loads records for the LaunchCondition table\r
3767 </summary>\r
3768 <param name="database">The MSI database.</param>\r
3769 </member>\r
3770 <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMergeModules(System.String,System.String)">\r
3771 <summary>\r
3772 Merges Merge Modules into the MSI Database.\r
3773 </summary>\r
3774 <param name="Database">The MSI Database.</param>\r
3775 <param name="TempPath">The path to temporary files.</param>\r
3776 </member>\r
3777 <member name="T:NAnt.Contrib.Tasks.Msi.MsiTask">\r
3778 <summary>\r
3779 Creates a Windows Installer (also known as Microsoft Installer, or MSI) setup database for installing software on the Windows Platform. \r
3780 </summary>\r
3781 <remarks>\r
3782 <para>\r
3783 Requires <c>cabarc.exe</c> in the path. This tool is part of the \r
3784 <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.\r
3785 </para>\r
3786 <para>\r
3787 Requires <c>mergemod.dll</c> version 2.0 or greater. This dll is part of the \r
3788 <see href="http://www.microsoft.com/msdownload/platformsdk/instmsi.htm">Microsoft Platform SDK</see>.\r
3789 </para>\r
3790 <para>\r
3791 See the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/roadmap_to_windows_installer_documentation.asp?frame=true" >Roadmap to Windows Installer Documentation</see> \r
3792 at Microsoft's MSDN website for more information.\r
3793 </para>\r
3794 </remarks>\r
3795 </member>\r
3796 <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.InitializeTask(System.Xml.XmlNode)">\r
3797 <summary>\r
3798 Initializes task and verifies parameters.\r
3799 </summary>\r
3800 <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>\r
3801 </member>\r
3802 <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.ExecuteTask">\r
3803 <summary>\r
3804 Executes the task.\r
3805 </summary>\r
3806 </member>\r
3807 <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiLicense">\r
3808 <summary>\r
3809 An .rtf (rich text format) file containing the license agreement \r
3810 for your software. The contents of this file will be displayed to \r
3811 the user when setup runs and must be accepted to continue.\r
3812 </summary>\r
3813 </member>\r
3814 <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBanner">\r
3815 <summary>\r
3816 A .bmp (bitmap) file 495x60 pixels in size that will be displayed \r
3817 as the banner (top) image of the installation user interface.\r
3818 </summary>\r
3819 </member>\r
3820 <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBackground">\r
3821 <summary>\r
3822 A .bmp (bitmap) file 495x315 pixels in size that will be displayed \r
3823 as the background image of the installation user interface.\r
3824 </summary>\r
3825 </member>\r
3826 <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiFeaturesElement">\r
3827 <summary>\r
3828 <para>\r
3829 Groups sets of components into named sets, these can be used to \r
3830 layout the tree control that allows users to select and deselect \r
3831 features of your software product when a custom installation is \r
3832 selected at runtime.\r
3833 </para>\r
3834 <h3>Parameters</h3>\r
3835 <list type="table">\r
3836 <listheader>\r
3837 <term>Attribute</term>\r
3838 <term>Type</term>\r
3839 <term>Description</term>\r
3840 <term>Required</term>\r
3841 </listheader>\r
3842 <item>\r
3843 <term>name</term>\r
3844 <term>string</term>\r
3845 <term>A name used to refer to the feature.</term>\r
3846 <term>True</term>\r
3847 </item>\r
3848 <item>\r
3849 <term>display</term>\r
3850 <term>int</term>\r
3851 <term>The number in this field specifies the order in which the feature is to be displayed in the user interface. \r
3852 The value also determines if the feature is initially displayed expanded or collapsed.<br/>\r
3853 If the value is null or zero, the record is not displayed. If the value is odd, the feature node is expanded initially. \r
3854 If the value is even, the feature node is collapsed initially.\r
3855 </term>\r
3856 <term>True</term>\r
3857 </item>\r
3858 <item>\r
3859 <term>title</term>\r
3860 <term>string</term>\r
3861 <term>Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog.</term>\r
3862 <term>False</term>\r
3863 </item>\r
3864 <item>\r
3865 <term>typical</term>\r
3866 <term>bool</term>\r
3867 <term>Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features.</term>\r
3868 <term>False</term>\r
3869 </item>\r
3870 <item>\r
3871 <term>directory</term>\r
3872 <term>string</term>\r
3873 <term>Refrence to a directory. Specify a corresponding directory to go with the feature.</term>\r
3874 <term>False</term>\r
3875 </item>\r
3876 <item>\r
3877 <term>attr</term>\r
3878 <term>int</term>\r
3879 <term>Any combination of the following: \r
3880 <list type="table">\r
3881 <listheader>\r
3882 <term>Value</term>\r
3883 <description>Description</description>\r
3884 </listheader>\r
3885 <item>\r
3886 <term>0</term>\r
3887 <description>Components of this feature that are not marked for installation from source are installed locally.</description>\r
3888 </item>\r
3889 <item>\r
3890 <term>1</term>\r
3891 <description>Components of this feature not marked for local installation are installed to run from the source CD-ROM or server.</description>\r
3892 </item>\r
3893 <item>\r
3894 <term>2</term>\r
3895 <description>Set this attribute and the state of the feature is the same as the state of the feature's parent.</description>\r
3896 </item>\r
3897 <item>\r
3898 <term>4</term>\r
3899 <description>Set this attribute and the feature state is Advertise.</description>\r
3900 </item>\r
3901 <item>\r
3902 <term>8</term>\r
3903 <description>Note that this bit works only with features that are listed by the ADVERTISE property. <br/>Set this attribute to prevent the feature from being advertised.</description>\r
3904 </item>\r
3905 <item>\r
3906 <term>16</term>\r
3907 <description>Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI.</description>\r
3908 </item>\r
3909 <item>\r
3910 <term>32</term>\r
3911 <description>Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors.</description>\r
3912 </item>\r
3913 </list>\r
3914 More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp</a>\r
3915 </term>\r
3916 <term>False</term>\r
3917 </item>\r
3918 </list>\r
3919 <h3>Nested Elements:</h3>\r
3920 <h4><feature></h4>\r
3921 <ul>\r
3922 Nested feature elements are supported.\r
3923 </ul>\r
3924 <h4></feature></h4>\r
3925 <h4><description></h4>\r
3926 <ul>\r
3927 Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog. \r
3928 </ul>\r
3929 <h4></description></h4>\r
3930 <h4><conditions></h4>\r
3931 <ul>\r
3932 <h4><condition></h4>\r
3933 <ul>\r
3934 <list type="table">\r
3935 <listheader>\r
3936 <term>Attribute</term>\r
3937 <term>Type</term>\r
3938 <term>Description</term>\r
3939 <term>Required</term>\r
3940 </listheader>\r
3941 <item>\r
3942 <term>expression</term>\r
3943 <term>string</term>\r
3944 <term>If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the \r
3945 conditional install level. <br/>\r
3946 The expression in the Condition column should not contain reference to the installed state of any feature or component. \r
3947 This is because the expressions in the Condition column are evaluated before the installer evaluates the installed \r
3948 states of features and components. Any expression in the Condition table that attempts to check the installed state \r
3949 of a feature or component always evaluates to false.<br/>\r
3950 For information on the syntax of conditional statements, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/conditional_statement_syntax.asp">Conditional Statement Syntax</a>.\r
3951 </term>\r
3952 <term>True</term>\r
3953 </item>\r
3954 <item>\r
3955 <term>level</term>\r
3956 <term>int</term>\r
3957 <term>The installer sets the install level of this feature to the level specified in this column if the expression in \r
3958 the Condition column evaluates to TRUE. Set this value to 0 to have the component not install if the condition is not met.<br/>\r
3959 For any installation, there is a defined install level, which is an integral value from 1 to 32,767. The initial value \r
3960 is determined by the InstallLevel property, which is set in the Property table.<br/>\r
3961 A feature is installed only if the feature level value is less than or equal to the current install level. The user \r
3962 interface can be authored such that once the installation is initialized, the installer allows the user to modify the \r
3963 install level of any feature in the Feature table. For example, an author can define install level values that represent \r
3964 specific installation options, such as Complete, Typical, or Minimum, and then create a dialog box that uses \r
3965 SetInstallLevel ControlEvents to enable the user to select one of these states. Depending on the state the user selects, \r
3966 the dialog box sets the install level property to the corresponding value. If the author assigns Typical a level of 100 \r
3967 and the user selects Typical, only those features with a level of 100 or less are installed. In addition, the Custom \r
3968 option could lead to another dialog box containing a Selection Tree control. The Selection Tree would then allow the user \r
3969 to individually change whether each feature is installed.</term>\r
3970 <term>True</term>\r
3971 </item>\r
3972 </list>\r
3973 </ul>\r
3974 <h4></condition></h4>\r
3975 </ul>\r
3976 <h4></conditions></h4>\r
3977 <h3>Examples</h3>\r
3978 <example>\r
3979 <para>Define a sample features structure.</para>\r
3980 <code>\r
3981 <features>\r
3982 <feature name="F__Default" title="My Product" display="1" typical="true" directory="TARGETDIR">\r
3983 <description>My Product from ACME, Inc. </description>\r
3984 <feature name="F__MainFiles" display="0" typical="true" />\r
3985 </feature>\r
3986 <feature name="F__Help" title="My Product Help Files" display="1" typical="false" directory="D__ACME_MyProduct_Help" />\r
3987 </features> \r
3988 </code>\r
3989 </example>\r
3990 </summary>\r
3991 </member>\r
3992 <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiMergeModulesElement">\r
3993 <summary>\r
3994 <para>\r
3995 Includes pre-packaged installation components (.msm files) as part \r
3996 of the msi database. This feature allows reuse of installation \r
3997 components that use MSI technology from other setup vendors or as \r
3998 created by the <see cref="T:NAnt.Contrib.Tasks.Msi.MsmTask"/>.\r
3999 </para>\r
4000 <h3>Parameters</h3>\r
4001 <list type="table">\r
4002 <listheader>\r
4003 <term>Attribute</term>\r
4004 <term>Type</term>\r
4005 <term>Description</term>\r
4006 <term>Required</term>\r
4007 </listheader>\r
4008 <item>\r
4009 <term>feature</term>\r
4010 <term>string</term>\r
4011 <term>Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module.</term>\r
4012 <term>True</term>\r
4013 </item>\r
4014 </list>\r
4015 <h3>Nested Elements:</h3>\r
4016 <h4><modules></h4>\r
4017 <ul>\r
4018 Specifies the merge module(s) to include with the specified feature.\r
4019 </ul>\r
4020 <h4></modules></h4>\r
4021 <h4><configurationitems></h4>\r
4022 <ul>\r
4023 <h4><configurationitem></h4>\r
4024 <ul>\r
4025 Specifies the value for a configurable item\r
4026 <h3>Parameters</h3>\r
4027 <list type="table">\r
4028 <listheader>\r
4029 <term>Attribute</term>\r
4030 <term>Type</term>\r
4031 <term>Description</term>\r
4032 <term>Required</term>\r
4033 </listheader>\r
4034 <item>\r
4035 <term>module</term>\r
4036 <term>string</term>\r
4037 <term>Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset.</term>\r
4038 <term>True</term>\r
4039 </item>\r
4040 <item>\r
4041 <term>name</term>\r
4042 <term>string</term>\r
4043 <term>Name of item for which data is to be set</term>\r
4044 <term>True</term>\r
4045 </item>\r
4046 <item>\r
4047 <term>value</term>\r
4048 <term>string</term>\r
4049 <term>Value of the configurable item</term>\r
4050 <term>True</term>\r
4051 </item>\r
4052 </list>\r
4053 </ul>\r
4054 <h4></configurationitem></h4>\r
4055 </ul>\r
4056 <h4></configurationitems></h4>\r
4057 <h3>Examples</h3>\r
4058 <example>\r
4059 <para>Add the NAnt merge module to the install.</para>\r
4060 <code>\r
4061 <mergemodules>\r
4062 <merge feature="F__NAntMSM">\r
4063 <modules>\r
4064 <include name="${nant.dir}\Install\NAnt.msm" />\r
4065 </modules>\r
4066 </merge>\r
4067 </mergemodules>\r
4068 </code>\r
4069 </example>\r
4070 <example>\r
4071 <para>Add a Visual Studio .wid package (merge module) and specify some configurable items.</para>\r
4072 <code>\r
4073 <mergemodules>\r
4074 <merge feature="F__DefaultFeature">\r
4075 <modules>\r
4076 <include name="VsdReadmeDlg.wid" />\r
4077 </modules>\r
4078 <configurationitems>\r
4079 <configurationitem name="BannerBitmap" value="CONFIGURED_BANNERBITMAP" />\r
4080 <configurationitem module="VsdReadmeDlg.wid" name="ReadmeText" value="CONFIGURED_READMETEXT" />\r
4081 </configurationitems>\r
4082 </merge>\r
4083 </mergemodules>\r
4084 </code>\r
4085 </example>\r
4086 </summary>\r
4087 </member>\r
4088 <member name="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand">\r
4089 <summary>\r
4090 Summary description for MsmTaskInfo.\r
4091 </summary>\r
4092 </member>\r
4093 <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSignature(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
4094 <summary>\r
4095 Loads records for the ModuleSignature table.\r
4096 </summary>\r
4097 <param name="database">The MSM database.</param>\r
4098 </member>\r
4099 <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleDependency(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
4100 <summary>\r
4101 Loads records for the ModuleDependency table.\r
4102 </summary>\r
4103 <param name="database">The MSM database.</param>\r
4104 </member>\r
4105 <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleExclusion(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
4106 <summary>\r
4107 Loads records for the ModuleExclusion table.\r
4108 </summary>\r
4109 <param name="database">The MSM database.</param>\r
4110 </member>\r
4111 <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
4112 <summary>\r
4113 Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence,\r
4114 ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables.\r
4115 </summary>\r
4116 <param name="database">The MSM database.</param>\r
4117 </member>\r
4118 <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleIgnoreTable(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
4119 <summary>\r
4120 Loads records for the ModuleIgnoreTable table.\r
4121 </summary>\r
4122 <param name="database">The MSM database.</param>\r
4123 </member>\r
4124 <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSubstitution(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
4125 <summary>\r
4126 Loads records for the ModuleSubstitution table.\r
4127 </summary>\r
4128 <param name="database">The MSM database.</param>\r
4129 </member>\r
4130 <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleConfiguration(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">\r
4131 <summary>\r
4132 Loads records for the ModuleConfiguration table.\r
4133 </summary>\r
4134 <param name="database">The MSM database.</param>\r
4135 </member>\r
4136 <member name="T:NAnt.Contrib.Tasks.Msi.MsmTask">\r
4137 <summary>\r
4138 Builds a Windows Installer Merge Module (MSM) database.\r
4139 </summary>\r
4140 <para>\r
4141 Requires <c>cabarc.exe</c> in the path. This tool is part of the \r
4142 <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.\r
4143 </para>\r
4144 </member>\r
4145 <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.InitializeTask(System.Xml.XmlNode)">\r
4146 <summary>\r
4147 Initializes task and verifies parameters.\r
4148 </summary>\r
4149 <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>\r
4150 </member>\r
4151 <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.ExecuteTask">\r
4152 <summary>\r
4153 Executes the task.\r
4154 </summary>\r
4155 </member>\r
4156 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmId">\r
4157 <summary>\r
4158 Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature\r
4159 </summary>\r
4160 </member>\r
4161 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmLanguage">\r
4162 <summary>\r
4163 Specifies the numeric language ID or IDs for a merge module.\r
4164 </summary>\r
4165 </member>\r
4166 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmVersion">\r
4167 <summary>\r
4168 Stores the version number of a merge module.\r
4169 </summary>\r
4170 </member>\r
4171 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleDependenciesElement">\r
4172 <summary>\r
4173 <para>\r
4174 Lists other merge modules that are required for this merge module \r
4175 to operate properly.\r
4176 </para>\r
4177 <para>\r
4178 Contains any number of dependency elements.\r
4179 </para>\r
4180 <para>\r
4181 More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduledependency_table.asp">here</see>.\r
4182 </para>\r
4183 <h3>Parameters</h3>\r
4184 <list type="table">\r
4185 <listheader>\r
4186 <term>Attribute</term>\r
4187 <term>Type</term>\r
4188 <term>Description</term>\r
4189 <term>Required</term>\r
4190 </listheader>\r
4191 <item>\r
4192 <term>id</term>\r
4193 <term>string</term>\r
4194 <term>Identifier of the merge module required</term>\r
4195 <term>True</term>\r
4196 </item>\r
4197 <item>\r
4198 <term>language</term>\r
4199 <term>string</term>\r
4200 <term>Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency.</term>\r
4201 <term>True</term>\r
4202 </item>\r
4203 <item>\r
4204 <term>version</term>\r
4205 <term>string</term>\r
4206 <term>Version of the dependent merge module. If ommited, any version fills the dependency.</term>\r
4207 <term>False</term>\r
4208 </item>\r
4209 </list>\r
4210 <h3>Examples</h3>\r
4211 <example>\r
4212 <para>Make sure that the NAnt merge module is included</para>\r
4213 <code>\r
4214 <moduledependencies>\r
4215 <dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" />\r
4216 </moduledependencies>\r
4217 </code>\r
4218 </example>\r
4219 </summary>\r
4220 </member>\r
4221 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleExclusionsElement">\r
4222 <summary>\r
4223 <para>\r
4224 Lists other merge modules that are incompatible in the same \r
4225 installer database.\r
4226 </para>\r
4227 <para>\r
4228 Contains any number of exclusion elements.\r
4229 </para>\r
4230 <para>\r
4231 More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleexclusion_table.asp">here</see>.\r
4232 </para>\r
4233 <h3>Parameters</h3>\r
4234 <list type="table">\r
4235 <listheader>\r
4236 <term>Attribute</term>\r
4237 <term>Type</term>\r
4238 <term>Description</term>\r
4239 <term>Required</term>\r
4240 </listheader>\r
4241 <item>\r
4242 <term>id</term>\r
4243 <term>string</term>\r
4244 <term>Identifier of the merge module required</term>\r
4245 <term>True</term>\r
4246 </item>\r
4247 <item>\r
4248 <term>language</term>\r
4249 <term>string</term>\r
4250 <term>Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows.\r
4251 <list type="table">\r
4252 <listheader>\r
4253 <term>ExcludedLanguage</term>\r
4254 <description>Description</description>\r
4255 </listheader>\r
4256 <item>\r
4257 <term>> 0</term>\r
4258 <description>Exclude the language IDs specified by ExcludedLanguage.</description>\r
4259 </item>\r
4260 <item>\r
4261 <term>= 0</term>\r
4262 <description>Exclude no language IDs.</description>\r
4263 </item>\r
4264 <item>\r
4265 <term>< 0</term>\r
4266 <description>Exclude all language IDs except those specified by ExcludedLanguage.</description>\r
4267 </item>\r
4268 </list>\r
4269 </term>\r
4270 <term>True</term>\r
4271 </item>\r
4272 <item>\r
4273 <term>minversion</term>\r
4274 <term>string</term>\r
4275 <term>Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>\r
4276 <term>False</term>\r
4277 </item>\r
4278 <item>\r
4279 <term>maxversion</term>\r
4280 <term>string</term>\r
4281 <term>Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>\r
4282 <term>False</term>\r
4283 </item>\r
4284 </list>\r
4285 <h3>Examples</h3>\r
4286 <example>\r
4287 <para>Exclude the all NAnt merge modules created before version 0.85.0</para>\r
4288 <code>\r
4289 <moduleexclusions>\r
4290 <exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" />\r
4291 </moduleexclusions>\r
4292 </code>\r
4293 </example>\r
4294 </summary>\r
4295 </member>\r
4296 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSequencesElement">\r
4297 <summary>\r
4298 <para>\r
4299 Used to modify the sequence of tasks/events that execute during the \r
4300 overall installation process.\r
4301 </para>\r
4302 <h3>Parameters</h3>\r
4303 <list type="table">\r
4304 <listheader>\r
4305 <term>Attribute</term>\r
4306 <term>Type</term>\r
4307 <term>Description</term>\r
4308 <term>Required</term>\r
4309 </listheader>\r
4310 <item>\r
4311 <term>type</term>\r
4312 <term>msi:MSISequenceTable</term>\r
4313 <term>Valid inputs:\r
4314 <list type="bullet">\r
4315 <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstallexecutesequence_table.asp">ModuleInstallExecuteSequence Table</a>.</item>\r
4316 <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstalluisequence_table.asp">ModuleInstallUISequence Table</a></item>\r
4317 <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminexecutesequence_table.asp">ModuleAdminExecuteSequence Table</a></item>\r
4318 <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminuisequence_table.asp">ModuleAdminUISequence Table</a></item>\r
4319 <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadvtuisequence_table.asp">ModuleAdvtUISequence Table</a></item>\r
4320 </list>\r
4321 </term>\r
4322 <term>True</term>\r
4323 </item>\r
4324 <item>\r
4325 <term>action</term>\r
4326 <term>string</term>\r
4327 <term>Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.<br/>If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted.</term>\r
4328 <term>True</term>\r
4329 </item>\r
4330 <item>\r
4331 <term>sequence</term>\r
4332 <term>int</term>\r
4333 <term>The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted <br/>When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions.</term>\r
4334 <term>False</term>\r
4335 </item>\r
4336 <item>\r
4337 <term>baseaction</term>\r
4338 <term>string</term>\r
4339 <term>Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table.</term>\r
4340 <term>False</term>\r
4341 </item>\r
4342 <item>\r
4343 <term>after</term>\r
4344 <term>bool</term>\r
4345 <term>Boolean for whether Action comes before or after BaseAction\r
4346 <list type="table">\r
4347 <listheader>\r
4348 <term>Value</term>\r
4349 <description>Description</description>\r
4350 </listheader>\r
4351 <item>\r
4352 <term>True</term>\r
4353 <description>Action to come after BaseAction</description>\r
4354 </item>\r
4355 <item>\r
4356 <term>False</term>\r
4357 <description>Action to come before BaseAction</description>\r
4358 </item>\r
4359 </list>\r
4360 </term>\r
4361 <term>False</term>\r
4362 </item>\r
4363 <item>\r
4364 <term>condition</term>\r
4365 <term>string</term>\r
4366 <term>A conditional statement that indicates if the action is be executed.</term>\r
4367 <term>False</term>\r
4368 </item>\r
4369 </list>\r
4370 </summary>\r
4371 </member>\r
4372 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleIgnoreTablesElement">\r
4373 <summary>\r
4374 <para>\r
4375 If a table in the merge module is listed in the ModuleIgnoreTable \r
4376 table, it is not merged into the .msi file. If the table already \r
4377 exists in the .msi file, it is not modified by the merge. The tables \r
4378 in the ModuleIgnoreTable can therefore contain data that is unneeded \r
4379 after the merge.\r
4380 </para>\r
4381 <para>\r
4382 More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleignoretable_table.asp?frame=true">here</see>.\r
4383 </para>\r
4384 <h3>Parameters</h3>\r
4385 <list type="table">\r
4386 <listheader>\r
4387 <term>Attribute</term>\r
4388 <term>Type</term>\r
4389 <term>Description</term>\r
4390 <term>Required</term>\r
4391 </listheader>\r
4392 <item>\r
4393 <term>table</term>\r
4394 <term>string</term>\r
4395 <term>Name of the table in the merge module that is not to be merged into the .msi file.</term>\r
4396 <term>True</term>\r
4397 </item>\r
4398 </list>\r
4399 <h3>Examples</h3>\r
4400 <example>\r
4401 <para>Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0</para>\r
4402 <code>\r
4403 <moduleignoretables>\r
4404 <table name="ModuleConfiguration" />\r
4405 <table name="ModuleSubstitution" />\r
4406 <table name="_ModuleConfigurationGroup" />\r
4407 </moduleignoretables>\r
4408 </code>\r
4409 </example>\r
4410 </summary>\r
4411 </member>\r
4412 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSubstitutionsElement">\r
4413 <summary>\r
4414 <para>\r
4415 The ModuleSubstitution table specifies the configurable fields of a \r
4416 module database and provides a template for the configuration of each \r
4417 field. The user or merge tool may query this table to determine what \r
4418 configuration operations are to take place. This table is not merged \r
4419 into the target database.\r
4420 </para>\r
4421 <para>\r
4422 More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/modulesubstitution_table.asp">here</see>.\r
4423 </para>\r
4424 <h3>Parameters</h3>\r
4425 <list type="table">\r
4426 <listheader>\r
4427 <term>Attribute</term>\r
4428 <term>Type</term>\r
4429 <term>Description</term>\r
4430 <term>Required</term>\r
4431 </listheader>\r
4432 <item>\r
4433 <term>table</term>\r
4434 <term>string</term>\r
4435 <term>Name of the table being modified in the module database.</term>\r
4436 <term>True</term>\r
4437 </item>\r
4438 <item>\r
4439 <term>row</term>\r
4440 <term>string</term>\r
4441 <term>Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.<br/>Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value.</term>\r
4442 <term>True</term>\r
4443 </item>\r
4444 <item>\r
4445 <term>column</term>\r
4446 <term>string</term>\r
4447 <term>Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined.</term>\r
4448 <term>True</term>\r
4449 </item>\r
4450 <item>\r
4451 <term>value</term>\r
4452 <term>string</term>\r
4453 <term>Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails.\r
4454 <list type="bullet">\r
4455 <item>\r
4456 This column uses CMSM special format. A literal semicolon (';') or equals sign ('=') can be added to the table by prefixing the character with a backslash. '\'.\r
4457 </item>\r
4458 <item>\r
4459 The Value field may contain multiple substitution strings. For example, the configuration of items "Food1" and "Food2" in the string: "[=Food1] is good, but [=Food2] is better because [=Food2] is more nutritious."\r
4460 </item>\r
4461 <item>\r
4462 Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid.\r
4463 </item>\r
4464 <item>\r
4465 If the Value field evaluates to null, and the target field is not nullable, the merge fails and an error object of type msmErrorBadNullSubstitution is created and added to the error list. For details, see the error types described in get_Type Function.\r
4466 </item>\r
4467 <item>\r
4468 If the Value field evaluates to the null GUID: {00000000-0000-0000-0000-000000000000}, the null GUID is replaced by the name of the feature before the row is merged into the module. For details, see Referencing Features in Merge Modules.\r
4469 </item>\r
4470 <item>\r
4471 The template in the Value field is evaluated before being inserted into the target field. Substitution into a row is done before replacing any features.\r
4472 </item>\r
4473 <item>\r
4474 If the Value column evaluates to a string of only integer characters (with an optional + or -), the string is converted into an integer before being substituted into an target field of the Integer Format Type. If the template evaluates to a string that does not consist only of integer characters (and an optional + or -) the result cannot be substituted into an integer target field. Attempting to insert a non-integer into an integer field causes the merge to fail and adds a msmErrorBadSubstitutionType error object to the error list.\r
4475 </item>\r
4476 <item>\r
4477 If the target column specified in the Table and Column fields is a Text Format Type, and evaluation of the Value field results in an Integer Format Type, a decimal representation of the number is inserted into the target text field.\r
4478 </item>\r
4479 <item>\r
4480 If the target field is an Integer Format Type, and the Value field consists of a non-delimited list of items in Bitfield Format, the value in the target field is combined using the bitwise AND operator with the inverse of the bitwise OR of all of the mask values from the items, then combined using the bitwise OR operator with each of the integer or bitfield items when masked by their corresponding mask values. Essentially, this explicitly sets the bits from the properties to the provided values but leaves all other bits in the cell alone.\r
4481 </item>\r
4482 <item>\r
4483 If the Value field evaluates to a Key Format Type, and is a key into a table that uses multiple primary keys, the item name may be followed by a semicolon and an integer value that indicates the 1-based index into the set of values that together make a primary key. If no integer is specified, the value 1 is used. For example, the Control table has two primary key columns, Dialog_ and Control. The value of an item "Item1" that is a key into the Control table will be of the form "DialogName;ControlName", where DialogName is the value in the Dialog_ table and ControlName is the value in the Control column. To substitute just ControlName, the substitution string [=Item1;2] should be used.\r
4484 </item>\r
4485 </list>\r
4486 </term>\r
4487 <term>False</term>\r
4488 </item>\r
4489 </list>\r
4490 </summary>\r
4491 </member>\r
4492 <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleConfigurationsElement">\r
4493 <summary>\r
4494 <para>\r
4495 Identifies the configurable attributes of the module. This table is \r
4496 not merged into the database.\r
4497 </para>\r
4498 <para>\r
4499 More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleconfiguration_table.asp">here</see>.\r
4500 </para>\r
4501 <h3>Parameters</h3>\r
4502 <list type="table">\r
4503 <listheader>\r
4504 <term>Attribute</term>\r
4505 <term>Type</term>\r
4506 <term>Description</term>\r
4507 <term>Required</term>\r
4508 </listheader>\r
4509 <item>\r
4510 <term>name</term>\r
4511 <term>string</term>\r
4512 <term>Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table.</term>\r
4513 <term>True</term>\r
4514 </item>\r
4515 <item>\r
4516 <term>format</term>\r
4517 <term>msi:MSMModuleConfigurationFormat</term>\r
4518 <term>Specifies the format of the data being changed\r
4519 <list type="bullet">\r
4520 <item>text</item>\r
4521 <item>key</item>\r
4522 <item>integer</item>\r
4523 <item>bitfield</item>\r
4524 </list>\r
4525 </term>\r
4526 <term>True</term>\r
4527 </item>\r
4528 <item>\r
4529 <term>type</term>\r
4530 <term>string</term>\r
4531 <term>Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute.</term>\r
4532 <term>False</term>\r
4533 </item>\r
4534 <item>\r
4535 <term>contextdata</term>\r
4536 <term>string</term>\r
4537 <term>Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes.</term>\r
4538 <term>False</term>\r
4539 </item>\r
4540 <item>\r
4541 <term>defaultvalue</term>\r
4542 <term>string</term>\r
4543 <term>Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.<br/>Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state.</term>\r
4544 <term>False</term>\r
4545 </item>\r
4546 <item>\r
4547 <term>attr</term>\r
4548 <term>int</term>\r
4549 <term>Bit field containing attributes for this configurable item. Null is equivalent to 0.\r
4550 <list type="table">\r
4551 <listheader>\r
4552 <term>Value</term>\r
4553 <description>Description</description>\r
4554 </listheader>\r
4555 <item>\r
4556 <term>1</term>\r
4557 <description>This attribute only applies to records that list a foreign key to a module table in their DefaultValue field.</description>\r
4558 </item>\r
4559 <item>\r
4560 <term>2</term>\r
4561 <description>When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types.</description>\r
4562 </item>\r
4563 </list>\r
4564 </term>\r
4565 <term>False</term>\r
4566 </item>\r
4567 <item>\r
4568 <term>displayname</term>\r
4569 <term>string</term>\r
4570 <term>Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI.</term>\r
4571 <term>False</term>\r
4572 </item>\r
4573 <item>\r
4574 <term>description</term>\r
4575 <term>string</term>\r
4576 <term>Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform.</term>\r
4577 <term>False</term>\r
4578 </item>\r
4579 <item>\r
4580 <term>helplocation</term>\r
4581 <term>string</term>\r
4582 <term>Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available.</term>\r
4583 <term>False</term>\r
4584 </item>\r
4585 <item>\r
4586 <term>helpkeyword</term>\r
4587 <term>string</term>\r
4588 <term>Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute.</term>\r
4589 <term>False</term>\r
4590 </item>\r
4591 </list>\r
4592 </summary>\r
4593 </member>\r
4594 <member name="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord">\r
4595 <summary>\r
4596 Maintains a forward reference to a .tlb file\r
4597 in the same directory as an assembly .dll\r
4598 that has been registered for COM interop.\r
4599 </summary>\r
4600 </member>\r
4601 <member name="M:NAnt.Contrib.Tasks.Msi.TypeLibRecord.#ctor(System.String,System.String,System.Reflection.AssemblyName,System.String,System.String)">\r
4602 <summary>\r
4603 Creates a new <see cref="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord"/>.\r
4604 </summary>\r
4605 <param name="LibId">The typelibrary id.</param>\r
4606 <param name="TypeLibFileName">The typelibrary filename.</param>\r
4607 <param name="AssemblyName">The name of the assembly.</param>\r
4608 <param name="FeatureName">The feature containing the typelibrary's file.</param>\r
4609 <param name="AssemblyComponent">The name of the Assembly's component.</param>\r
4610 </member>\r
4611 <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyComponent">\r
4612 <summary>\r
4613 Retrieves the name of the Assembly's component.\r
4614 </summary>\r
4615 <value>The Assembly's component Name.</value>\r
4616 </member>\r
4617 <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.TypeLibFileName">\r
4618 <summary>\r
4619 Retrieves the typelibrary filename.\r
4620 </summary>\r
4621 <value>The typelibrary filename.</value>\r
4622 </member>\r
4623 <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.LibId">\r
4624 <summary>\r
4625 Retrieves the typelibrary id.\r
4626 </summary>\r
4627 <value>The typelibrary id.</value>\r
4628 </member>\r
4629 <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyName">\r
4630 <summary>\r
4631 Retrieves the name of the assembly.\r
4632 </summary>\r
4633 <value>The name of the assembly.</value>\r
4634 </member>\r
4635 <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.FeatureName">\r
4636 <summary>\r
4637 Retrieves the feature containing the typelibrary's file.\r
4638 </summary>\r
4639 <value>The feature containing the typelibrary's file.</value>\r
4640 </member>\r
4641 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask">\r
4642 <summary>\r
4643 Adds files to a PVCS repository.\r
4644 </summary>\r
4645 <remarks>\r
4646 <para>\r
4647 This task uses the <c>addfiles</c> PCLI command to add files to a PVCS repository.\r
4648 </para>\r
4649 </remarks>\r
4650 <example>\r
4651 <para>\r
4652 Adds <c>File1.txt</c> and <c>File2.txt</c> to the root level of the \r
4653 project database specified by the <c>project-database</c> property.\r
4654 </para>\r
4655 <code>\r
4656 <![CDATA[\r
4657 <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control.">\r
4658 <entities>\r
4659 <entity name="C:\Data\File1.txt"/>\r
4660 <entity name="C:\Data\Folder\File2.txt"/>\r
4661 </entities>\r
4662 </pvcsaddfiles>\r
4663 ]]>\r
4664 </code>\r
4665 </example>\r
4666 <example>\r
4667 <para>\r
4668 Adds <c>File1.txt</c> and <c>File2.txt</c> to the <c>folder</c> project\r
4669 of the project database specified by the <c>project-database</c> \r
4670 property.\r
4671 </para>\r
4672 <code>\r
4673 <![CDATA[\r
4674 <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." projectpath="/folder">\r
4675 <entities>\r
4676 <entity name="C:\Data\File1.txt"/>\r
4677 <entity name="C:\Data\Folder\File2.txt"/>\r
4678 </entities>\r
4679 </pvcsaddfiles>\r
4680 ]]>\r
4681 </code>\r
4682 </example>\r
4683 <example>\r
4684 <para>\r
4685 Adds <c>another_file.txt</c> and all files and folders at and below \r
4686 <c>C:\Data</c> to the project database specified by the <c>project-database</c>\r
4687 property.\r
4688 </para>\r
4689 <code>\r
4690 <![CDATA[\r
4691 <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." includesubprojects="true">\r
4692 <entities>\r
4693 <entity name="C:\Data\"/>\r
4694 <entity name="C:\Temp\another_file.txt"/>\r
4695 </entities>\r
4696 </pvcsaddfiles>\r
4697 ]]>\r
4698 </code>\r
4699 </example>\r
4700 <example>\r
4701 <para>\r
4702 Adds all files at and below <c>C:\Data\</c> to the project database specified by the <c>project-database</c>\r
4703 property. Workfiles will be copied to the workfile location and will overwrite any existing files (as\r
4704 dictated by the <c>copymode</c> attribute). The relevant revisions will be locked in PVCS. Added files\r
4705 will be assigned the <c>SYSTEST</c> promotion group. \r
4706 </para>\r
4707 <code>\r
4708 <![CDATA[\r
4709 <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Files." copymode="CopyWorkfileWithOverwrite" lock="true" promotiongroup="SYSTEST" includesubprojects="true">\r
4710 <entities>\r
4711 <entity name="C:\Data\"/>\r
4712 </entities>\r
4713 </pvcsaddfiles>\r
4714 ]]>\r
4715 </code>\r
4716 </example>\r
4717 </member>\r
4718 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask">\r
4719 <summary>\r
4720 Base class for all PVCS project database tasks that operate against one or more entities.\r
4721 </summary>\r
4722 </member>\r
4723 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask">\r
4724 <summary>\r
4725 A base class for PVCS tasks that deal with project databases.\r
4726 </summary>\r
4727 <remarks>\r
4728 <para>\r
4729 This class can be used as a base class for PVCS tasks that operate against a project database. It provides\r
4730 common attributes and functionality for such tasks.\r
4731 </para>\r
4732 </remarks>\r
4733 </member>\r
4734 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSTask">\r
4735 <summary>\r
4736 Base class functionality for all PVCS tasks.\r
4737 </summary>\r
4738 </member>\r
4739 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._pvcsBin">\r
4740 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin"/>\r
4741 </member>\r
4742 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._process">\r
4743 <summary>\r
4744 This is the PCLI process that is run by this task.\r
4745 </summary>\r
4746 </member>\r
4747 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.StartProcess">\r
4748 <summary>\r
4749 Starts the process that is wrapped by this PVCS task.\r
4750 </summary>\r
4751 <remarks>\r
4752 Provided only to seal the implementation of <c>StartProcess()</c>.\r
4753 </remarks>\r
4754 <returns>The process that was started.</returns>\r
4755 </member>\r
4756 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExecuteTask">\r
4757 <summary>\r
4758 Executes the task.\r
4759 </summary>\r
4760 <remarks>\r
4761 Provided only to seal the implementation of <c>ExecuteTask()</c>.\r
4762 </remarks>\r
4763 </member>\r
4764 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.PrepareProcess(System.Diagnostics.Process)">\r
4765 <summary>\r
4766 Prepares the process wrapped by this task for execution.\r
4767 </summary>\r
4768 <param name="process">The process to prepare for execution.</param>\r
4769 </member>\r
4770 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
4771 <summary>\r
4772 Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the\r
4773 PVCS command-line tool.\r
4774 </summary>\r
4775 <param name="arguments">The collection of arguments.</param>\r
4776 </member>\r
4777 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.GetProgramArguments">\r
4778 <summary>\r
4779 Constructs the program arguments that should be used when executing the wrapped PVCS process.\r
4780 </summary>\r
4781 <returns>A <c>string</c> containing the program arguments.</returns>\r
4782 </member>\r
4783 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin">\r
4784 <summary>\r
4785 Gets or sets the location of the PVCS binary command-line tools.\r
4786 </summary>\r
4787 <remarks>\r
4788 <para>\r
4789 Generally, the PVCS command-line tools will be available on the current path. However, if this is not\r
4790 the case then this property allows an exact location to be specified. If this property is not set, the\r
4791 task will assume that the PVCS binaries are available on the current path.\r
4792 </para>\r
4793 </remarks>\r
4794 </member>\r
4795 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.Process">\r
4796 <summary>\r
4797 Gets or sets the process that is run as a result of running this task.\r
4798 </summary>\r
4799 </member>\r
4800 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ProgramArguments">\r
4801 <summary>\r
4802 Gets the program arguments with which to run the wrapped PVCS process.\r
4803 </summary>\r
4804 </member>\r
4805 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExeName">\r
4806 <summary>\r
4807 Gets the executable name for the command-line tool to run for the PVCS task.\r
4808 </summary>\r
4809 </member>\r
4810 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName">\r
4811 <summary>\r
4812 Gets the PCLI command name that corresponds to the operation the task performs.\r
4813 </summary>\r
4814 <remarks>\r
4815 <para>\r
4816 By default, this property will return the name of the task minus the starting "pvcs". Subclasses need\r
4817 only override this property if there is a mismatch between the task name and the PCLI command name.\r
4818 </para>\r
4819 </remarks>\r
4820 </member>\r
4821 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubprojects">\r
4822 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/>\r
4823 </member>\r
4824 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._password">\r
4825 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password"/>\r
4826 </member>\r
4827 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectDatabase">\r
4828 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase"/>\r
4829 </member>\r
4830 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectPath">\r
4831 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath"/>\r
4832 </member>\r
4833 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._userId">\r
4834 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId"/>\r
4835 </member>\r
4836 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._workspace">\r
4837 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace"/>\r
4838 </member>\r
4839 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubProjectsUsed">\r
4840 <summary>\r
4841 Set to <c>true</c> if the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/> property is manipulated. Some tasks don't\r
4842 support this property and so an exception will be thrown if the property is used.\r
4843 </summary>\r
4844 </member>\r
4845 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
4846 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
4847 </member>\r
4848 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects">\r
4849 <summary>\r
4850 Gets or sets a value indicating whether the operation should include subprojects.\r
4851 </summary>\r
4852 <remarks>\r
4853 <para>\r
4854 This is equivalent to the <c>-z</c> command-line option.\r
4855 </para>\r
4856 </remarks>\r
4857 </member>\r
4858 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects">\r
4859 <summary>\r
4860 Gets a value indicating whether the specific task implementation supports the <c>includesubprojects</c>\r
4861 task attribute. If not, an exception will be thrown if an attempt is made to set the attribute.\r
4862 </summary>\r
4863 </member>\r
4864 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password">\r
4865 <summary>\r
4866 Gets or sets the password to use when connecting to the project database.\r
4867 </summary>\r
4868 <remarks>\r
4869 <para>\r
4870 This is equivalent to the password part of the <c>-id</c> command-line option.\r
4871 </para>\r
4872 </remarks>\r
4873 </member>\r
4874 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId">\r
4875 <summary>\r
4876 Gets or sets the user ID to use when connecting to the project database.\r
4877 </summary>\r
4878 <remarks>\r
4879 <para>\r
4880 This is equivalent to the user ID part of the <c>-id</c> command-line option.\r
4881 </para>\r
4882 </remarks>\r
4883 </member>\r
4884 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace">\r
4885 <summary>\r
4886 Gets or sets the workspace to use when connecting to the project database.\r
4887 </summary>\r
4888 <remarks>\r
4889 <para>\r
4890 This is equivalent to the <c>-sp</c> command-line option.\r
4891 </para>\r
4892 </remarks>\r
4893 </member>\r
4894 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase">\r
4895 <summary>\r
4896 Gets or sets the project database to utilize during the operation.\r
4897 </summary>\r
4898 <remarks>\r
4899 <para>\r
4900 This is equivalent to the <c>-pr</c> command-line option.\r
4901 </para>\r
4902 </remarks>\r
4903 </member>\r
4904 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath">\r
4905 <summary>\r
4906 Gets or sets the project path to utilize during the operation.\r
4907 </summary>\r
4908 <remarks>\r
4909 <para>\r
4910 This is equivalent to the <c>-pp</c> command-line option.\r
4911 </para>\r
4912 </remarks>\r
4913 </member>\r
4914 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask._entities">\r
4915 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities"/>\r
4916 </member>\r
4917 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.#ctor">\r
4918 <summary>\r
4919 Constructs and initializes an instance of <c>PVCSMultipleEntityTask</c>.\r
4920 </summary>\r
4921 </member>\r
4922 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
4923 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
4924 </member>\r
4925 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities">\r
4926 <summary>\r
4927 Gets or sets the entities involved in the operation.\r
4928 </summary>\r
4929 </member>\r
4930 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._archiveDescription">\r
4931 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription"/>\r
4932 </member>\r
4933 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._copyMode">\r
4934 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode"/>\r
4935 </member>\r
4936 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._deleteWorkfiles">\r
4937 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles"/>\r
4938 </member>\r
4939 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._description">\r
4940 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description"/>\r
4941 </member>\r
4942 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._lock">\r
4943 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock"/>\r
4944 </member>\r
4945 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._promotionGroup">\r
4946 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup"/>\r
4947 </member>\r
4948 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._suppressAddIfExists">\r
4949 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists"/>\r
4950 </member>\r
4951 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._versionLabel">\r
4952 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel"/>\r
4953 </member>\r
4954 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.#ctor">\r
4955 <summary>\r
4956 Constructs and initializes an instance of <c>PVCSAddFilesTask</c>.\r
4957 </summary>\r
4958 </member>\r
4959 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
4960 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
4961 </member>\r
4962 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription">\r
4963 <summary>\r
4964 Gets or sets the archive description for versioned files.\r
4965 </summary>\r
4966 <remarks>\r
4967 <para>\r
4968 This is equivalent to the <c>-t</c> parameter to the <c>pcli addfiles</c> command.\r
4969 </para>\r
4970 </remarks>\r
4971 </member>\r
4972 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode">\r
4973 <summary>\r
4974 Gets or sets the copy mode for the operation.\r
4975 </summary>\r
4976 </member>\r
4977 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles">\r
4978 <summary>\r
4979 Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS.\r
4980 </summary>\r
4981 <remarks>\r
4982 <para>\r
4983 This is equivalent to the <c>-d</c> parameter to the <c>pcli addfiles</c> command.\r
4984 </para>\r
4985 </remarks>\r
4986 </member>\r
4987 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description">\r
4988 <summary>\r
4989 Gets or sets the description for versioned files.\r
4990 </summary>\r
4991 <remarks>\r
4992 <para>\r
4993 This is equivalent to the <c>-m</c> parameter to the <c>pcli addfiles</c> command.\r
4994 </para>\r
4995 </remarks>\r
4996 </member>\r
4997 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock">\r
4998 <summary>\r
4999 Gets or sets a value indicating whether versioned files should be locked after being added to PVCS.\r
5000 </summary>\r
5001 <remarks>\r
5002 <para>\r
5003 This is equivalent to the <c>-l</c> parameter to the <c>pcli addfiles</c> command.\r
5004 </para>\r
5005 </remarks>\r
5006 </member>\r
5007 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup">\r
5008 <summary>\r
5009 Gets or sets the promotion group to which added files will be assigned. Setting this attribute to an\r
5010 empty string indicates the versioned files will not be assigned to any promotion group.\r
5011 </summary>\r
5012 <remarks>\r
5013 <para>\r
5014 This is equivalent to the <c>-g</c> parameter to the <c>pcli addfiles</c> command.\r
5015 </para>\r
5016 </remarks>\r
5017 </member>\r
5018 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists">\r
5019 <summary>\r
5020 Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS\r
5021 repository.\r
5022 </summary>\r
5023 <remarks>\r
5024 <para>\r
5025 This is equivalent to the <c>-qw</c> parameter to the <c>pcli addfiles</c> command.\r
5026 </para>\r
5027 </remarks>\r
5028 </member>\r
5029 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel">\r
5030 <summary>\r
5031 Gets or sets the version label to assign to the added versioned files.\r
5032 </summary>\r
5033 <remarks>\r
5034 <para>\r
5035 This is equivalent to the <c>-v</c> parameter to the <c>pcli addfiles</c> command.\r
5036 </para>\r
5037 </remarks>\r
5038 </member>\r
5039 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode">\r
5040 <summary>\r
5041 Specifies possible copy modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask"/> task.\r
5042 </summary>\r
5043 </member>\r
5044 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.Default">\r
5045 <summary>\r
5046 Indicates the default copy mode should be used.\r
5047 </summary>\r
5048 </member>\r
5049 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileIfRequired">\r
5050 <summary>\r
5051 Indicates that workfiles should be copied to the project workfile location is it doesn't already exist.\r
5052 </summary>\r
5053 </member>\r
5054 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileWithOverwrite">\r
5055 <summary>\r
5056 Indicates that workfiles should be copied to the project workfile location and overwrite any existing\r
5057 workfile.\r
5058 </summary>\r
5059 </member>\r
5060 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask">\r
5061 <summary>\r
5062 Adds a user to a PVCS project or project database.\r
5063 </summary>\r
5064 <remarks>\r
5065 <para>\r
5066 This task uses the <c>adduser</c> PCLI command to add the user to the PVCS project or database.\r
5067 </para>\r
5068 </remarks>\r
5069 <example>\r
5070 <para>\r
5071 Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the\r
5072 <c>project-database</c> property.\r
5073 </para>\r
5074 <code>\r
5075 <![CDATA[\r
5076 <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*"/>\r
5077 ]]>\r
5078 </code>\r
5079 </example>\r
5080 <example>\r
5081 <para>\r
5082 Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the\r
5083 <c>project-database</c> property. The user's logon will expire on the 26th of October, 2005.\r
5084 </para>\r
5085 <code>\r
5086 <![CDATA[\r
5087 <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*" expirydate="10/26/2005"/>\r
5088 ]]>\r
5089 </code>\r
5090 </example>\r
5091 </member>\r
5092 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._expiryDate">\r
5093 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate"/>\r
5094 </member>\r
5095 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userPassword">\r
5096 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword"/>\r
5097 </member>\r
5098 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userName">\r
5099 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName"/>\r
5100 </member>\r
5101 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.#ctor">\r
5102 <summary>\r
5103 Constructs and initializes an instance of <c>PVCSAddUserTask</c>.\r
5104 </summary>\r
5105 </member>\r
5106 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5107 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5108 </member>\r
5109 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate">\r
5110 <summary>\r
5111 Gets or sets the expiration date for the new user.\r
5112 </summary>\r
5113 <remarks>\r
5114 <para>\r
5115 This is equivalent to the <c>-e</c> parameter to the <c>pcli adduser</c> command.\r
5116 </para>\r
5117 </remarks>\r
5118 </member>\r
5119 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword">\r
5120 <summary>\r
5121 Gets or sets the password for the new user.\r
5122 </summary>\r
5123 </member>\r
5124 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName">\r
5125 <summary>\r
5126 Gets or sets the user name for the new user.\r
5127 </summary>\r
5128 </member>\r
5129 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.SupportsIncludeSubprojects">\r
5130 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>\r
5131 </member>\r
5132 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask">\r
5133 <summary>\r
5134 Assigns a promotion group to versioned files.\r
5135 </summary>\r
5136 <remarks>\r
5137 <para>\r
5138 This task uses the <c>assigngroup</c> PCLI command to assign the group to versioned files.\r
5139 </para>\r
5140 </remarks>\r
5141 <example>\r
5142 <para>\r
5143 Assigns the <c>SYSTEST</c> promotion group to all entities with the <c>DEV</c> promotion group in the\r
5144 <c>folder</c> project.\r
5145 </para>\r
5146 <code>\r
5147 <![CDATA[\r
5148 <pvcsassigngroup projectdatabase="${project-database}" entity="/folder" assignpromotiongroup="SYSTEST" promotiongroup="DEV"/>\r
5149 ]]>\r
5150 </code>\r
5151 </example>\r
5152 <example>\r
5153 <para>\r
5154 Assigns the <c>SYSTEST</c> promotion group to revision <c>1.2</c> of all entities.\r
5155 </para>\r
5156 <code>\r
5157 <![CDATA[\r
5158 <pvcsassigngroup projectdatabase="${project-database}" entity="/" includesubprojects="true" assignpromotiongroup="SYSTEST" revision="1.2"/>\r
5159 ]]>\r
5160 </code>\r
5161 </example>\r
5162 </member>\r
5163 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask">\r
5164 <summary>\r
5165 Base class for all PVCS project database tasks that operate against a single entity.\r
5166 </summary>\r
5167 </member>\r
5168 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask._entity">\r
5169 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity"/>\r
5170 </member>\r
5171 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5172 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5173 </member>\r
5174 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity">\r
5175 <summary>\r
5176 Gets or sets the entity involved in the operation.\r
5177 </summary>\r
5178 </member>\r
5179 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._assignPromotionGroup">\r
5180 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup"/>\r
5181 </member>\r
5182 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._promotionGroup">\r
5183 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup"/>\r
5184 </member>\r
5185 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._revision">\r
5186 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision"/>\r
5187 </member>\r
5188 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._versionLabel">\r
5189 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel"/>\r
5190 </member>\r
5191 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.#ctor">\r
5192 <summary>\r
5193 Constructs and initializes an instance of <c>PVCSAssignGroupTask</c>.\r
5194 </summary>\r
5195 </member>\r
5196 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5197 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5198 </member>\r
5199 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup">\r
5200 <summary>\r
5201 Gets or sets the promotion group to assign to the versioned files.\r
5202 </summary>\r
5203 <remarks>\r
5204 <para>\r
5205 This is equivalent to the <c>-g</c> parameter to the <c>pcli assigngroup</c> command.\r
5206 </para>\r
5207 </remarks>\r
5208 </member>\r
5209 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup">\r
5210 <summary>\r
5211 Gets or sets the promotion group for the versioned files to be assigned the promotion group.\r
5212 </summary>\r
5213 <remarks>\r
5214 <para>\r
5215 This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.\r
5216 </para>\r
5217 </remarks>\r
5218 </member>\r
5219 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision">\r
5220 <summary>\r
5221 Gets or sets the revision for the versioned files to be assigned the promotion group.\r
5222 </summary>\r
5223 <remarks>\r
5224 <para>\r
5225 This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.\r
5226 </para>\r
5227 <para>\r
5228 If this property has not yet been set, it will return <c>Double.MaxValue</c>.\r
5229 </para>\r
5230 </remarks>\r
5231 </member>\r
5232 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel">\r
5233 <summary>\r
5234 Gets or sets the version label for the versioned files to be assigned the promotion group.\r
5235 </summary>\r
5236 <remarks>\r
5237 <para>\r
5238 This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.\r
5239 </para>\r
5240 </remarks>\r
5241 </member>\r
5242 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask">\r
5243 <summary>\r
5244 Changes the promotion group for specified versioned files.\r
5245 </summary>\r
5246 <remarks>\r
5247 <para>\r
5248 This task uses the <c>changegroup</c> PCLI command to change the group for versioned files.\r
5249 </para>\r
5250 </remarks>\r
5251 <example>\r
5252 <para>\r
5253 Changes the promotion group for <c>file.txt</c> from <c>SYSTEST</c> to <c>DEV</c>.\r
5254 </para>\r
5255 <code>\r
5256 <![CDATA[\r
5257 <pvcschangegroup projectdatabase="${project-database}" from="SYSTEST" to="DEV" entity="/file.txt"/>\r
5258 ]]>\r
5259 </code>\r
5260 </example>\r
5261 <example>\r
5262 <para>\r
5263 Changes the promotion group for all files from <c>DEV</c> to <c>PROD</c>.\r
5264 </para>\r
5265 <code>\r
5266 <![CDATA[\r
5267 <pvcschangegroup projectdatabase="${project-database}" from="DEV" to="PROD" entity="/" includesubprojects="true"/>\r
5268 ]]>\r
5269 </code>\r
5270 </example>\r
5271 </member>\r
5272 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._from">\r
5273 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From"/>\r
5274 </member>\r
5275 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._to">\r
5276 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To"/>\r
5277 </member>\r
5278 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5279 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5280 </member>\r
5281 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From">\r
5282 <summary>\r
5283 Gets or sets the promotion group to change from.\r
5284 </summary>\r
5285 <remarks>\r
5286 <para>\r
5287 This is equivalent to the <c>-gf</c> parameter to the <c>pcli changegroup</c> command.\r
5288 </para>\r
5289 </remarks>\r
5290 </member>\r
5291 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To">\r
5292 <summary>\r
5293 Gets or sets the promotion group to change to.\r
5294 </summary>\r
5295 <remarks>\r
5296 <para>\r
5297 This is equivalent to the <c>-gt</c> parameter to the <c>pcli changegroup</c> command.\r
5298 </para>\r
5299 </remarks>\r
5300 </member>\r
5301 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument">\r
5302 <summary>\r
5303 Encapsulates the details of a PVCS command argument.\r
5304 </summary>\r
5305 <remarks>\r
5306 <para>\r
5307 PVCS tasks must "fill in" a collection of arguments to be passed to the PVCS command line interface (PCLI).\r
5308 This class represents one such argument.\r
5309 </para>\r
5310 <para>\r
5311 Each argument consists of a command and an optional command value. The command is always passed to the PVCS\r
5312 command line utility and is therefore required. An example of a command is "-g" which is passed to many\r
5313 PVCS command line utilities to specify a promotion group.\r
5314 </para>\r
5315 <para>\r
5316 The command value is used to specify extra information to the command. For example, if the command is "-g"\r
5317 then the command value would be the name of the promotion group.\r
5318 </para>\r
5319 <para>\r
5320 The command can be assigned a position (see the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/> property). This position defines\r
5321 where the command appears relative to other commands. For example, some commands must appear after other\r
5322 commands. Therefore, they should be assigned a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.\r
5323 </para>\r
5324 </remarks>\r
5325 </member>\r
5326 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._command">\r
5327 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>\r
5328 </member>\r
5329 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._commandValue">\r
5330 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue"/>\r
5331 </member>\r
5332 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._position">\r
5333 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/>\r
5334 </member>\r
5335 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String)">\r
5336 <summary>\r
5337 Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. No value is\r
5338 applied and the argument has a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.\r
5339 </summary>\r
5340 <param name="command">The command string.</param>\r
5341 </member>\r
5342 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object)">\r
5343 <summary>\r
5344 Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. The argument has\r
5345 a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.\r
5346 </summary>\r
5347 <param name="command">The command string.</param>\r
5348 <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>\r
5349 </member>\r
5350 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">\r
5351 <summary>\r
5352 Constructs an instance of <c>PVCSCommandArgument</c> with the specified information.\r
5353 </summary>\r
5354 <param name="command">The command string.</param>\r
5355 <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>\r
5356 <param name="position">The position for the command.</param>\r
5357 </member>\r
5358 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CompareTo(System.Object)">\r
5359 <summary>\r
5360 Compares two PVCS command arguments based on their position.\r
5361 </summary>\r
5362 <param name="o">The PVCS command argument to compare to <c>this</c>.</param>\r
5363 <returns>\r
5364 Less than zero if this instance is less than <paramref name="o"/>.\r
5365 Zero if this instance is equal to <paramref name="o"/>.\r
5366 Greater than zero if this instance is greater than <paramref name="o"/>.\r
5367 </returns>\r
5368 </member>\r
5369 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.ToString">\r
5370 <summary>\r
5371 Converts this command argument to its <c>string</c> representation.\r
5372 </summary>\r
5373 <returns>The <c>string</c> representation of this command argument.</returns>\r
5374 </member>\r
5375 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.EscapeStringCommandArgument(System.String)">\r
5376 <summary>\r
5377 Escapes a <c>string</c> command line argument.\r
5378 </summary>\r
5379 <remarks>\r
5380 <para>\r
5381 This method attempts to deal with the mess of keeping both PCLI and the shell happy with string\r
5382 arguments. It's not perfect yet (try an argument with several backslashes before a double quote). It\r
5383 would be nice to have a regex to handle this but I wouldn't even bother until this logic is spot on.\r
5384 </para>\r
5385 </remarks>\r
5386 <param name="argument">The string argument to escape.</param>\r
5387 <returns>The escaped string argument.</returns>\r
5388 </member>\r
5389 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command">\r
5390 <summary>\r
5391 Gets a <c>string</c> that contains the command to pass to PVCS.\r
5392 </summary>\r
5393 </member>\r
5394 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue">\r
5395 <summary>\r
5396 Gets the value to append to <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>.\r
5397 </summary>\r
5398 <remarks>\r
5399 <para>\r
5400 If this property is <c>null</c>, no value will be appended to the command.\r
5401 </para>\r
5402 </remarks>\r
5403 </member>\r
5404 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position">\r
5405 <summary>\r
5406 Gets the position for the command.\r
5407 </summary>\r
5408 </member>\r
5409 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection">\r
5410 <summary>\r
5411 Implements a type-safe collection of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/>s.\r
5412 </summary>\r
5413 </member>\r
5414 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">\r
5415 <see cref="M:System.Collections.IList.Add(System.Object)"/>\r
5416 </member>\r
5417 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String)">\r
5418 <summary>\r
5419 Adds a new command argument to this collection with the specified information.\r
5420 </summary>\r
5421 <param name="command">The command string for the new command.</param>\r
5422 </member>\r
5423 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object)">\r
5424 <summary>\r
5425 Adds a new command argument to this collection with the specified information.\r
5426 </summary>\r
5427 <param name="command">The command string for the new command.</param>\r
5428 <param name="commandValue">\r
5429 The command value for the new command, or <c>null</c> if no value applies.\r
5430 </param>\r
5431 </member>\r
5432 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">\r
5433 <summary>\r
5434 Adds a new command argument to this collection with the specified information.\r
5435 </summary>\r
5436 <param name="command">The command string for the new command.</param>\r
5437 <param name="commandValue">\r
5438 The command value for the new command, or <c>null</c> if no value applies.\r
5439 </param>\r
5440 <param name="position">The position for the new command.</param>\r
5441 </member>\r
5442 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.AddRange(System.Collections.ICollection)">\r
5443 <summary>\r
5444 Adds all specified command arguments to this collection.\r
5445 </summary>\r
5446 <param name="commandArguments">The collection of command arguments to add.</param>\r
5447 </member>\r
5448 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.IndexOf(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">\r
5449 <see cref="M:System.Collections.IList.IndexOf(System.Object)"/>\r
5450 </member>\r
5451 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Insert(System.Int32,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">\r
5452 <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)"/>\r
5453 </member>\r
5454 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Remove(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">\r
5455 <see cref="M:System.Collections.IList.Remove(System.Object)"/>\r
5456 </member>\r
5457 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Contains(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">\r
5458 <see cref="M:System.Collections.IList.Contains(System.Object)"/>\r
5459 </member>\r
5460 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.ToArray">\r
5461 <summary>\r
5462 Retrieves an array of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in this collection.\r
5463 </summary>\r
5464 <returns>An array of command arguments in this collection.</returns>\r
5465 </member>\r
5466 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnInsert(System.Int32,System.Object)">\r
5467 <see cref="M:System.Collections.CollectionBase.OnInsert(System.Int32,System.Object)"/>\r
5468 </member>\r
5469 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnSet(System.Int32,System.Object,System.Object)">\r
5470 <see cref="M:System.Collections.CollectionBase.OnSet(System.Int32,System.Object,System.Object)"/>\r
5471 </member>\r
5472 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnValidate(System.Object)">\r
5473 <see cref="M:System.Collections.CollectionBase.OnValidate(System.Object)"/>\r
5474 </member>\r
5475 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Item(System.Int32)">\r
5476 <summary>\r
5477 Allows the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in the collection to be manipulated.\r
5478 </summary>\r
5479 </member>\r
5480 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition">\r
5481 <summary>\r
5482 Defines possible values for specifying positions for PCLI command arguments and arguments to PCLI itself.\r
5483 </summary>\r
5484 <remarks>\r
5485 <para>\r
5486 Members of this enumeration are used to specify relative positions of PCLI command arguments. All arguments\r
5487 given a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/> will appear after arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>\r
5488 or <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>. Similarly, arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/> will appear after\r
5489 those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/> but before those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>.\r
5490 </para>\r
5491 <para>\r
5492 No order is guaranteed for arguments with the same position. That is, if two arguments have a position of\r
5493 <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>, it is not possible to specify which one is output to the command line first.\r
5494 </para>\r
5495 <para>\r
5496 The <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand"/> member is special in that it ensures the argument will appear before\r
5497 the PCLI command name. This is useful when the argument is to PCLI itself, not the PCLI command.\r
5498 </para>\r
5499 </remarks>\r
5500 </member>\r
5501 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand">\r
5502 <summary>\r
5503 Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI\r
5504 itself (as opposed to the PCLI command).\r
5505 </summary>\r
5506 </member>\r
5507 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start">\r
5508 <summary>\r
5509 PCLI command arguments that should appear before other PCLI command arguments.\r
5510 </summary>\r
5511 </member>\r
5512 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle">\r
5513 <summary>\r
5514 PCLI command arguments that should appear before other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>\r
5515 but after other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.\r
5516 </summary>\r
5517 </member>\r
5518 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End">\r
5519 <summary>\r
5520 PCLI command arguments that should appear after other PCLI command arguments.\r
5521 </summary>\r
5522 </member>\r
5523 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask">\r
5524 <summary>\r
5525 Creates a project in a PVCS repository.\r
5526 </summary>\r
5527 <remarks>\r
5528 <para>\r
5529 This task uses the <c>createproject</c> PCLI command to create the project in the PVCS repository.\r
5530 </para>\r
5531 </remarks>\r
5532 <example>\r
5533 <para>\r
5534 Creates a project called <c>Songs</c> in the project database specified by the <c>project-database</c>\r
5535 property. The workfile location for the project is set to <c>C:\Work\Songs</c>.\r
5536 </para>\r
5537 <code>\r
5538 <![CDATA[\r
5539 <pvcscreateproject projectdatabase="${project-database}" workfilelocation="C:\Work\Songs" entity="/Songs"/>\r
5540 ]]>\r
5541 </code>\r
5542 </example>\r
5543 </member>\r
5544 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask._workfileLocation">\r
5545 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation"/>\r
5546 </member>\r
5547 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5548 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5549 </member>\r
5550 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation">\r
5551 <summary>\r
5552 Gets or sets the workfile location for the created project.\r
5553 </summary>\r
5554 <remarks>\r
5555 <para>\r
5556 This is equivalent to the <c>-w</c> parameter to the <c>pcli createproject</c> command.\r
5557 </para>\r
5558 </remarks>\r
5559 </member>\r
5560 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.SupportsIncludeSubprojects">\r
5561 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>\r
5562 </member>\r
5563 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask">\r
5564 <summary>\r
5565 Removes a specified promotion group from versioned files.\r
5566 </summary>\r
5567 <remarks>\r
5568 <para>\r
5569 This task uses the <c>deletegroup</c> PCLI command to remove the promotion group from the versioned files.\r
5570 </para>\r
5571 </remarks>\r
5572 <example>\r
5573 <para>\r
5574 Removes the <c>DEV</c> promotion group from <c>App.ico</c> in the project database specified by the\r
5575 <c>project-database</c> property.\r
5576 </para>\r
5577 <code>\r
5578 <![CDATA[\r
5579 <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/App.ico"/>\r
5580 ]]>\r
5581 </code>\r
5582 </example>\r
5583 <example>\r
5584 <para>\r
5585 Removes the <c>DEV</c> promotion group all files in the project database specified by the\r
5586 <c>project-database</c> property.\r
5587 </para>\r
5588 <code>\r
5589 <![CDATA[\r
5590 <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" includesubprojects="true"/>\r
5591 ]]>\r
5592 </code>\r
5593 </example>\r
5594 </member>\r
5595 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask._promotionGroup">\r
5596 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup"/>\r
5597 </member>\r
5598 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5599 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5600 </member>\r
5601 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup">\r
5602 <summary>\r
5603 Gets or sets the promotion group to delete.\r
5604 </summary>\r
5605 <remarks>\r
5606 <para>\r
5607 This is equivalent to the <c>-g</c> parameter to the <c>pcli deletegroup</c> command.\r
5608 </para>\r
5609 </remarks>\r
5610 </member>\r
5611 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask">\r
5612 <summary>\r
5613 Removes a label from specified versioned files or projects.\r
5614 </summary>\r
5615 <remarks>\r
5616 <para>\r
5617 This task uses the <c>deletelabel</c> PCLI command to remove the version label from the versioned files.\r
5618 </para>\r
5619 </remarks>\r
5620 <example>\r
5621 <para>\r
5622 Removes the label called <c>My Label</c> from the versioned file called <c>App.ico</c> from the project\r
5623 database specified by the <c>project-database</c> property.\r
5624 </para>\r
5625 <code>\r
5626 <![CDATA[\r
5627 <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label">\r
5628 <entities>\r
5629 <entity name="/App.ico"/>\r
5630 </entities>\r
5631 </pvcsdeletelabel>\r
5632 ]]>\r
5633 </code>\r
5634 </example>\r
5635 <example>\r
5636 <para>\r
5637 Removes the label called <c>My Label</c> from all files at and below both <c>folder1</c> and <c>folder2</c>\r
5638 in the project database specified by the <c>project-database</c> property.\r
5639 </para>\r
5640 <code>\r
5641 <![CDATA[\r
5642 <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label" includesubprojects="true">\r
5643 <entities>\r
5644 <entity name="/folder1"/>\r
5645 <entity name="/folder2"/>\r
5646 </entities>\r
5647 </pvcsdeletelabel>\r
5648 ]]>\r
5649 </code>\r
5650 </example>\r
5651 </member>\r
5652 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask._versionLabel">\r
5653 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel"/>\r
5654 </member>\r
5655 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5656 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5657 </member>\r
5658 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel">\r
5659 <summary>\r
5660 Gets or sets the version label to remove.\r
5661 </summary>\r
5662 <remarks>\r
5663 <para>\r
5664 This is equivalent to the <c>-v</c> parameter to the <c>pcli deletelabel</c> command.\r
5665 </para>\r
5666 </remarks>\r
5667 </member>\r
5668 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask">\r
5669 <summary>\r
5670 Deletes folder, projects, versioned items and workspaces in a PVCS repository.\r
5671 </summary>\r
5672 <remarks>\r
5673 <para>\r
5674 This task uses the <c>delete</c> PCLI command to delete the items.\r
5675 </para>\r
5676 </remarks>\r
5677 <example>\r
5678 <para>\r
5679 Deletes the versioned file called <c>App.ico</c> from the project database specified by the\r
5680 <c>project-database</c> property.\r
5681 </para>\r
5682 <code>\r
5683 <![CDATA[\r
5684 <pvcsdelete projectdatabase="${project-database}">\r
5685 <entities>\r
5686 <entity name="/App.ico"/>\r
5687 </entities>\r
5688 </pvcsdelete>\r
5689 ]]>\r
5690 </code>\r
5691 </example>\r
5692 <example>\r
5693 <para>\r
5694 Deletes the files called <c>file1.txt</c> and <c>file2.txt</c> from the project called <c>folder</c> in the\r
5695 project database specified by the <c>project-database</c> property.\r
5696 </para>\r
5697 <code>\r
5698 <![CDATA[\r
5699 <pvcsdelete projectdatabase="${project-database}" projectpath="/folder">\r
5700 <entities>\r
5701 <entity name="file1.txt"/>\r
5702 <entity name="file2.txt"/>\r
5703 </entities>\r
5704 </pvcsdelete>\r
5705 ]]>\r
5706 </code>\r
5707 </example>\r
5708 </member>\r
5709 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask.SupportsIncludeSubprojects">\r
5710 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>\r
5711 </member>\r
5712 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask">\r
5713 <summary>\r
5714 Deletes the specified users from the PVCS access control database.\r
5715 </summary>\r
5716 <remarks>\r
5717 <para>\r
5718 This task uses the <c>deleteuser</c> PCLI command to delete the users.\r
5719 </para>\r
5720 </remarks>\r
5721 <example>\r
5722 <para>\r
5723 Deletes the users called <c>kb</c>, <c>kv</c> and <c>tb</c> from the project database specified by the\r
5724 <c>project-database</c> property.\r
5725 </para>\r
5726 <code>\r
5727 <![CDATA[\r
5728 <pvcsdeleteusers projectdatabase="${project-database}">\r
5729 <entities>\r
5730 <entity name="kb"/>\r
5731 <entity name="kv"/>\r
5732 <entity name="tb"/>\r
5733 </entities>\r
5734 </pvcsdeleteusers>\r
5735 ]]>\r
5736 </code>\r
5737 </example>\r
5738 </member>\r
5739 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.SupportsIncludeSubprojects">\r
5740 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>\r
5741 </member>\r
5742 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.PCLICommandName">\r
5743 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName"/>\r
5744 </member>\r
5745 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSGetTask">\r
5746 <summary>\r
5747 Gets files from a PVCS repository.\r
5748 </summary>\r
5749 <remarks>\r
5750 <para>\r
5751 This task uses the <c>get</c> PCLI command to get the versioned files from PVCS.\r
5752 </para>\r
5753 </remarks>\r
5754 <example>\r
5755 <para>\r
5756 Gets the versioned file called <c>App.ico</c> from the project database specified by the\r
5757 <c>project-database</c> property.\r
5758 </para>\r
5759 <code>\r
5760 <![CDATA[\r
5761 <pvcsget projectdatabase="${project-database}">\r
5762 <entities>\r
5763 <entity name="/App.ico"/>\r
5764 </entities>\r
5765 </pvcsget>\r
5766 ]]>\r
5767 </code>\r
5768 </example>\r
5769 <example>\r
5770 <para>\r
5771 Gets the versioned file called <c>App.ico</c> from the project database specified by the\r
5772 <c>project-database</c> property. The file is also locked.\r
5773 </para>\r
5774 <code>\r
5775 <![CDATA[\r
5776 <pvcsget projectdatabase="${project-database}" lock="true">\r
5777 <entities>\r
5778 <entity name="/App.ico"/>\r
5779 </entities>\r
5780 </pvcsget>\r
5781 ]]>\r
5782 </code>\r
5783 </example>\r
5784 <example>\r
5785 <para>\r
5786 Gets all revisions assigned the <c>SYSTEST</c> promotion group from the project database specified by the\r
5787 <c>project-database</c> property. The workfiles are touched after the get operation.\r
5788 </para>\r
5789 <code>\r
5790 <![CDATA[\r
5791 <pvcsget projectdatabase="${project-database}" includesubprojects="true" promotiongroup="SYSTEST" touch="true">\r
5792 <entities>\r
5793 <entity name="/"/>\r
5794 </entities>\r
5795 </pvcsget>\r
5796 ]]>\r
5797 </code>\r
5798 </example>\r
5799 </member>\r
5800 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._baseProjectPath">\r
5801 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath"/>\r
5802 </member>\r
5803 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._location">\r
5804 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location"/>\r
5805 </member>\r
5806 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._lock">\r
5807 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock"/>\r
5808 </member>\r
5809 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._makeWritable">\r
5810 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable"/>\r
5811 </member>\r
5812 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._maxDateTime">\r
5813 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime"/>\r
5814 </member>\r
5815 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._overrideWorkfileLocation">\r
5816 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation"/>\r
5817 </member>\r
5818 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._promotionGroup">\r
5819 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup"/>\r
5820 </member>\r
5821 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._revision">\r
5822 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision"/>\r
5823 </member>\r
5824 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._touch">\r
5825 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch"/>\r
5826 </member>\r
5827 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._updateOnly">\r
5828 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly"/>\r
5829 </member>\r
5830 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._versionLabel">\r
5831 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel"/>\r
5832 </member>\r
5833 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.#ctor">\r
5834 <summary>\r
5835 Constructs and initializes an instance of <c>PVCSGetTask</c>.\r
5836 </summary>\r
5837 </member>\r
5838 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
5839 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
5840 </member>\r
5841 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath">\r
5842 <summary>\r
5843 Gets or sets the base project path.\r
5844 </summary>\r
5845 <remarks>\r
5846 <para>\r
5847 This is equivalent to the <c>-bp</c> parameter to the <c>pcli get</c> command.\r
5848 </para>\r
5849 </remarks>\r
5850 </member>\r
5851 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location">\r
5852 <summary>\r
5853 Gets or sets an alternative location for workfiles.\r
5854 </summary>\r
5855 <remarks>\r
5856 <para>\r
5857 This is equivalent to the <c>-a</c> parameter to the <c>pcli get</c> command.\r
5858 </para>\r
5859 </remarks>\r
5860 </member>\r
5861 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock">\r
5862 <summary>\r
5863 Gets or sets a value indicating whether revisions involved in the get operation should be locked.\r
5864 </summary>\r
5865 <remarks>\r
5866 <para>\r
5867 This is equivalent to the <c>-l</c> parameter to the <c>pcli get</c> command.\r
5868 </para>\r
5869 </remarks>\r
5870 </member>\r
5871 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable">\r
5872 <summary>\r
5873 Gets or sets whether the workfiles should be made writable.\r
5874 </summary>\r
5875 <remarks>\r
5876 <para>\r
5877 This is equivalent to the <c>-w</c> parameter to the <c>pcli get</c> command.\r
5878 </para>\r
5879 </remarks>\r
5880 </member>\r
5881 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime">\r
5882 <summary>\r
5883 Gets or sets the maximum date and time of workfiles to retrieve.\r
5884 </summary>\r
5885 <remarks>\r
5886 <para>\r
5887 This is equivalent to the <c>-d</c> parameter to the <c>pcli get</c> command.\r
5888 </para>\r
5889 <para>\r
5890 If this property has not yet been set, it will return <c>DateTime.MaxValue</c>.\r
5891 </para>\r
5892 </remarks>\r
5893 </member>\r
5894 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation">\r
5895 <summary>\r
5896 Gets or sets a value indicating whether the workfile location for files should be overridden.\r
5897 </summary>\r
5898 <remarks>\r
5899 <para>\r
5900 This is equivalent to the <c>-o</c> parameter to the <c>pcli get</c> command.\r
5901 </para>\r
5902 </remarks>\r
5903 </member>\r
5904 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup">\r
5905 <summary>\r
5906 Gets or sets the promotion group to get.\r
5907 </summary>\r
5908 <remarks>\r
5909 <para>\r
5910 This is equivalent to the <c>-g</c> parameter to the <c>pcli get</c> command.\r
5911 </para>\r
5912 </remarks>\r
5913 </member>\r
5914 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision">\r
5915 <summary>\r
5916 Gets or sets the revision to get against.\r
5917 </summary>\r
5918 <remarks>\r
5919 <para>\r
5920 This is equivalent to the <c>-r</c> parameter to the <c>pcli get</c> command.\r
5921 </para>\r
5922 <para>\r
5923 If this property has not yet been set, it will return <c>Double.MaxValue</c>.\r
5924 </para>\r
5925 </remarks>\r
5926 </member>\r
5927 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch">\r
5928 <summary>\r
5929 Gets or sets a value indicating whether workfiles should be touched after the get.\r
5930 </summary>\r
5931 <remarks>\r
5932 <para>\r
5933 This is equivalent to the <c>-t</c> parameter to the <c>pcli get</c> command.\r
5934 </para>\r
5935 </remarks>\r
5936 </member>\r
5937 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly">\r
5938 <summary>\r
5939 Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the\r
5940 current workfile.\r
5941 </summary>\r
5942 <remarks>\r
5943 <para>\r
5944 This is equivalent to the <c>-u</c> parameter to the <c>pcli get</c> command (without specifying a\r
5945 date or time).\r
5946 </para>\r
5947 </remarks>\r
5948 </member>\r
5949 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel">\r
5950 <summary>\r
5951 Gets or sets the version label to get against.\r
5952 </summary>\r
5953 <remarks>\r
5954 <para>\r
5955 This is equivalent to the <c>-v</c> parameter to the <c>pcli get</c> command.\r
5956 </para>\r
5957 </remarks>\r
5958 </member>\r
5959 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask">\r
5960 <summary>\r
5961 Assigns a version label to a revision of the specified versioned files.\r
5962 </summary>\r
5963 <remarks>\r
5964 <para>\r
5965 This task uses the <c>label</c> PCLI command to label the items.\r
5966 </para>\r
5967 </remarks>\r
5968 <example>\r
5969 <para>\r
5970 Labels all files in the project database specified by the <c>project-database</c> property. The label\r
5971 applied is <c>Beta</c>.\r
5972 </para>\r
5973 <code>\r
5974 <![CDATA[\r
5975 <pvcslabel projectdatabase="${project-database}" versionlabel="Beta" includesubprojects="true">\r
5976 <entities>\r
5977 <entity name="/"/>\r
5978 </entities>\r
5979 </pvcslabel>\r
5980 ]]>\r
5981 </code>\r
5982 </example>\r
5983 <example>\r
5984 <para>\r
5985 Labels revision <c>1.8</c> of <c>App.ico</c> as <c>Dodgy</c> in the project database specified by the\r
5986 <c>project-database</c> property.\r
5987 </para>\r
5988 <code>\r
5989 <![CDATA[\r
5990 <pvcslabel projectdatabase="${project-database}" versionlabel="Dodgy" revision="1.8">\r
5991 <entities>\r
5992 <entity name="App.ico"/>\r
5993 </entities>\r
5994 </pvcslabel>\r
5995 ]]>\r
5996 </code>\r
5997 </example>\r
5998 </member>\r
5999 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._floating">\r
6000 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating"/>\r
6001 </member>\r
6002 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._revision">\r
6003 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision"/>\r
6004 </member>\r
6005 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._versionLabel">\r
6006 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel"/>\r
6007 </member>\r
6008 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.#ctor">\r
6009 <summary>\r
6010 Constructs and initializes an instance of <c>PVCSLabel</c>.\r
6011 </summary>\r
6012 </member>\r
6013 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
6014 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
6015 </member>\r
6016 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating">\r
6017 <summary>\r
6018 Gets or sets a value indicating whether the label should "float" to the newest revision.\r
6019 </summary>\r
6020 <remarks>\r
6021 <para>\r
6022 This is equivalent to the <c>-f</c> parameter to the <c>pcli label</c> command.\r
6023 </para>\r
6024 </remarks>\r
6025 </member>\r
6026 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision">\r
6027 <summary>\r
6028 Gets or sets the revision to label.\r
6029 </summary>\r
6030 <remarks>\r
6031 <para>\r
6032 This is equivalent to the <c>-r</c> parameter to the <c>pcli label</c> command.\r
6033 </para>\r
6034 <para>\r
6035 If this property has not yet been set, it will return <c>Double.MaxValue</c>.\r
6036 </para>\r
6037 </remarks>\r
6038 </member>\r
6039 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel">\r
6040 <summary>\r
6041 Gets or sets the version label to assign.\r
6042 </summary>\r
6043 <remarks>\r
6044 <para>\r
6045 This is equivalent to the <c>-v</c> parameter to the <c>pcli label</c> command.\r
6046 </para>\r
6047 </remarks>\r
6048 </member>\r
6049 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLockTask">\r
6050 <summary>\r
6051 Locks a revision of the specified versioned files.\r
6052 </summary>\r
6053 <remarks>\r
6054 <para>\r
6055 This task uses the <c>lock</c> PCLI command to lock the versioned files.\r
6056 </para>\r
6057 </remarks>\r
6058 <example>\r
6059 <para>\r
6060 Locks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.\r
6061 </para>\r
6062 <code>\r
6063 <![CDATA[\r
6064 <pvcslock projectdatabase="${project-database}">\r
6065 <entities>\r
6066 <entity name="/App.ico"/>\r
6067 </entities>\r
6068 </pvcslock>\r
6069 ]]>\r
6070 </code>\r
6071 </example>\r
6072 <example>\r
6073 <para>\r
6074 Locks all files at and below <c>folder</c> in the project database specified by the <c>project-database</c>\r
6075 property.\r
6076 </para>\r
6077 <code>\r
6078 <![CDATA[\r
6079 <pvcslock projectdatabase="${project-database}" includesubprojects="true">\r
6080 <entities>\r
6081 <entity name="/folder"/>\r
6082 </entities>\r
6083 </pvcslock>\r
6084 ]]>\r
6085 </code>\r
6086 </example>\r
6087 </member>\r
6088 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noBranching">\r
6089 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching"/>\r
6090 </member>\r
6091 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noMultilock">\r
6092 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock"/>\r
6093 </member>\r
6094 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._promotionGroup">\r
6095 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup"/>\r
6096 </member>\r
6097 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._revision">\r
6098 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision"/>\r
6099 </member>\r
6100 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToBranching">\r
6101 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching"/>\r
6102 </member>\r
6103 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToMultilock">\r
6104 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock"/>\r
6105 </member>\r
6106 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.#ctor">\r
6107 <summary>\r
6108 Constructs and initializes an instance of <c>PVCSLock</c>.\r
6109 </summary>\r
6110 </member>\r
6111 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
6112 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
6113 </member>\r
6114 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching">\r
6115 <summary>\r
6116 Gets or sets a value indicating whether locking files will take place if checking in those files would\r
6117 result in a branch.\r
6118 </summary>\r
6119 <remarks>\r
6120 <para>\r
6121 This is equivalent to the <c>-nb</c> parameter to the <c>pcli lock</c> command.\r
6122 </para>\r
6123 </remarks>\r
6124 </member>\r
6125 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock">\r
6126 <summary>\r
6127 Gets or sets a value indicating whether already locked revisions will be locked.\r
6128 </summary>\r
6129 <remarks>\r
6130 <para>\r
6131 This is equivalent to the <c>-nm</c> parameter to the <c>pcli lock</c> command.\r
6132 </para>\r
6133 </remarks>\r
6134 </member>\r
6135 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup">\r
6136 <summary>\r
6137 Gets or sets the promotion group to assign the locked revision.\r
6138 </summary>\r
6139 <remarks>\r
6140 <para>\r
6141 This is equivalent to the <c>-g</c> parameter to the <c>pcli lock</c> command.\r
6142 </para>\r
6143 </remarks>\r
6144 </member>\r
6145 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision">\r
6146 <summary>\r
6147 Gets or sets the revision to lock.\r
6148 </summary>\r
6149 <remarks>\r
6150 <para>\r
6151 This is equivalent to the <c>-r</c> parameter to the <c>pcli lock</c> command.\r
6152 </para>\r
6153 <para>\r
6154 If this property has not yet been set, it will return <c>Double.MaxValue</c>.\r
6155 </para>\r
6156 </remarks>\r
6157 </member>\r
6158 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching">\r
6159 <summary>\r
6160 Gets or sets a value indicating whether revisions will be locked even if that will result in a branch\r
6161 upon check in.\r
6162 </summary>\r
6163 <remarks>\r
6164 <para>\r
6165 This is equivalent to the <c>-yb</c> parameter to the <c>pcli lock</c> command.\r
6166 </para>\r
6167 </remarks>\r
6168 </member>\r
6169 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock">\r
6170 <summary>\r
6171 Gets or sets a value indicating whether revisions will be locked even if that will result in multiple\r
6172 locks against the same revision.\r
6173 </summary>\r
6174 <remarks>\r
6175 <para>\r
6176 This is equivalent to the <c>-ym</c> parameter to the <c>pcli lock</c> command.\r
6177 </para>\r
6178 </remarks>\r
6179 </member>\r
6180 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask">\r
6181 <summary>\r
6182 Promotes versioned files to the next promotion group.\r
6183 </summary>\r
6184 <remarks>\r
6185 <para>\r
6186 This task uses the <c>promotegroup</c> PCLI command to promote versioned files.\r
6187 </para>\r
6188 </remarks>\r
6189 <example>\r
6190 <para>\r
6191 Promotes all files in the root of the project database specified by the <c>project-database</c> property.\r
6192 The files are promoted from the <c>DEV</c> promotion group to the next. Promotion will not take place across\r
6193 branches.\r
6194 </para>\r
6195 <code>\r
6196 <![CDATA[\r
6197 <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" acrossbranches="false"/>\r
6198 ]]>\r
6199 </code>\r
6200 </example>\r
6201 <example>\r
6202 <para>\r
6203 Promotes all files in the project database specified by the <c>project-database</c> property. The files are\r
6204 promoted from the <c>SYSTEST</c> promotion group to the next. Promotion will take place across branches.\r
6205 </para>\r
6206 <code>\r
6207 <![CDATA[\r
6208 <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="SYSTEST" entity="/" includesubprojects="true" acrossbranches="true"/>\r
6209 ]]>\r
6210 </code>\r
6211 </example>\r
6212 </member>\r
6213 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._acrossBrances">\r
6214 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches"/>\r
6215 </member>\r
6216 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._promotionGroup">\r
6217 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup"/>\r
6218 </member>\r
6219 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
6220 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
6221 </member>\r
6222 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches">\r
6223 <summary>\r
6224 Gets or sets a value indicating whether the promotion may occur across branches.\r
6225 </summary>\r
6226 <remarks>\r
6227 <para>\r
6228 This is equivalent to the <c>-nb</c> and <c>-yb</c> parameters to the <c>pcli promotegroup</c> command.\r
6229 </para>\r
6230 </remarks>\r
6231 </member>\r
6232 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup">\r
6233 <summary>\r
6234 Gets or sets the promotion group to be promoted.\r
6235 </summary>\r
6236 <remarks>\r
6237 <para>\r
6238 This is equivalent to the <c>-g</c> parameter to the <c>pcli promotegroup</c> command.\r
6239 </para>\r
6240 </remarks>\r
6241 </member>\r
6242 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPutTask">\r
6243 <summary>\r
6244 Puts files into a PVCS repository.\r
6245 </summary>\r
6246 <remarks>\r
6247 <para>\r
6248 This task uses the <c>put</c> PCLI command to put the files into PVCS.\r
6249 </para>\r
6250 </remarks>\r
6251 <example>\r
6252 <para>\r
6253 Puts the file called <c>App.ico</c> into the project database specified by the <c>project-database</c>\r
6254 property. The description for the change is <c>Added more colour</c>.\r
6255 </para>\r
6256 <code>\r
6257 <![CDATA[\r
6258 <pvcsput projectdatabase="${project-database}" description="Added more colour">\r
6259 <entities>\r
6260 <entity name="/App.ico"/>\r
6261 </entities>\r
6262 </pvcsput>\r
6263 ]]>\r
6264 </code>\r
6265 </example>\r
6266 <example>\r
6267 <para>\r
6268 Puts all files into the project database specified by the <c>project-database</c> property. The description\r
6269 for the changes is <c>Major changes</c>. Even if the workfiles have not been changed, they will result in a\r
6270 new revision in PVCS.\r
6271 </para>\r
6272 <code>\r
6273 <![CDATA[\r
6274 <pvcsput projectdatabase="${project-database}" description="Major changes" checkinunchanged="true" includesubprojects="true">\r
6275 <entities>\r
6276 <entity name="/"/>\r
6277 </entities>\r
6278 </pvcsput>\r
6279 ]]>\r
6280 </code>\r
6281 </example>\r
6282 <example>\r
6283 <para>\r
6284 Puts <c>file.txt</c> and all files in <c>folder</c> into the project database specified by the\r
6285 <c>project-database</c> property. The description for the changes is <c>Some changes</c>. A new branch is\r
6286 forcibly created via the <c>forcebranch</c> attribute. Leading and trailing whitespace is ignored when\r
6287 determining whether the workfile has been altered.\r
6288 </para>\r
6289 <code>\r
6290 <![CDATA[\r
6291 <pvcsput projectdatabase="${project-database}" description="Some changes" forcebranch="true" ignorespaces="true">\r
6292 <entities>\r
6293 <entity name="/folder"/>\r
6294 <entity name="/file.txt"/>\r
6295 </entities>\r
6296 </pvcsput>\r
6297 ]]>\r
6298 </code>\r
6299 </example>\r
6300 </member>\r
6301 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._baseProjectPath">\r
6302 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath"/>\r
6303 </member>\r
6304 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._checkInUnchanged">\r
6305 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged"/>\r
6306 </member>\r
6307 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._description">\r
6308 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description"/>\r
6309 </member>\r
6310 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._floatLabel">\r
6311 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel"/>\r
6312 </member>\r
6313 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._forceBranch">\r
6314 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch"/>\r
6315 </member>\r
6316 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._ignoreSpaces">\r
6317 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces"/>\r
6318 </member>\r
6319 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._keepWorkfile">\r
6320 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile"/>\r
6321 </member>\r
6322 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._location">\r
6323 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location"/>\r
6324 </member>\r
6325 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._lock">\r
6326 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock"/>\r
6327 </member>\r
6328 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._overrideWorkfileLocation">\r
6329 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation"/>\r
6330 </member>\r
6331 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._promotionGroup">\r
6332 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup"/>\r
6333 </member>\r
6334 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._reassignLabelIfExists">\r
6335 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists"/>\r
6336 </member>\r
6337 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._revision">\r
6338 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision"/>\r
6339 </member>\r
6340 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._useSameDescription">\r
6341 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription"/>\r
6342 </member>\r
6343 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._versionLabel">\r
6344 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>\r
6345 </member>\r
6346 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.#ctor">\r
6347 <summary>\r
6348 Constructs and initializes an instance of <c>PVCSPut</c>.\r
6349 </summary>\r
6350 </member>\r
6351 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
6352 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
6353 </member>\r
6354 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath">\r
6355 <summary>\r
6356 Gets or sets the base project path.\r
6357 </summary>\r
6358 <remarks>\r
6359 <para>\r
6360 This is equivalent to the <c>-bp</c> parameter to the <c>pcli put</c> command.\r
6361 </para>\r
6362 </remarks>\r
6363 </member>\r
6364 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged">\r
6365 <summary>\r
6366 Gets or sets a value indicating whether unchanged workfiles should be checked in.\r
6367 </summary>\r
6368 <remarks>\r
6369 <para>\r
6370 This is equivalent to the <c>-yf</c> parameter to the <c>pcli put</c> command.\r
6371 </para>\r
6372 </remarks>\r
6373 </member>\r
6374 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description">\r
6375 <summary>\r
6376 Gets or sets the description to be applied to the checked in revisions.\r
6377 </summary>\r
6378 <remarks>\r
6379 <para>\r
6380 This is equivalent to the <c>-m</c> parameter to the <c>pcli put</c> command.\r
6381 </para>\r
6382 </remarks>\r
6383 </member>\r
6384 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel">\r
6385 <summary>\r
6386 Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>\r
6387 should float.\r
6388 </summary>\r
6389 <remarks>\r
6390 <para>\r
6391 This is equivalent to the <c>-fv</c> parameter to the <c>pcli put</c> command.\r
6392 </para>\r
6393 </remarks>\r
6394 </member>\r
6395 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch">\r
6396 <summary>\r
6397 Gets or sets a value indicating whether a new branch will be created.\r
6398 </summary>\r
6399 <remarks>\r
6400 <para>\r
6401 This is equivalent to the <c>-fb</c> parameter to the <c>pcli put</c> command.\r
6402 </para>\r
6403 </remarks>\r
6404 </member>\r
6405 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces">\r
6406 <summary>\r
6407 Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining\r
6408 whether the revision has changed.\r
6409 </summary>\r
6410 <remarks>\r
6411 <para>\r
6412 This is equivalent to the <c>-b</c> parameter to the <c>pcli put</c> command.\r
6413 </para>\r
6414 </remarks>\r
6415 </member>\r
6416 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile">\r
6417 <summary>\r
6418 Gets or sets a value indicating whether the workfile should kept in its original state.\r
6419 </summary>\r
6420 <remarks>\r
6421 <para>\r
6422 This is equivalent to the <c>-k</c> parameter to the <c>pcli put</c> command.\r
6423 </para>\r
6424 </remarks>\r
6425 </member>\r
6426 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location">\r
6427 <summary>\r
6428 Gets or sets an alternative location for workfiles.\r
6429 </summary>\r
6430 <remarks>\r
6431 <para>\r
6432 This is equivalent to the <c>-a</c> parameter to the <c>pcli put</c> command.\r
6433 </para>\r
6434 </remarks>\r
6435 </member>\r
6436 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock">\r
6437 <summary>\r
6438 Gets or sets a value indicating the files should be locked after the put operation.\r
6439 </summary>\r
6440 <remarks>\r
6441 <para>\r
6442 This is equivalent to the <c>-l</c> parameter to the <c>pcli put</c> command.\r
6443 </para>\r
6444 </remarks>\r
6445 </member>\r
6446 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation">\r
6447 <summary>\r
6448 Gets or sets a value indicating whether the workfile location for files should be overridden.\r
6449 </summary>\r
6450 <remarks>\r
6451 <para>\r
6452 This is equivalent to the <c>-o</c> parameter to the <c>pcli put</c> command.\r
6453 </para>\r
6454 </remarks>\r
6455 </member>\r
6456 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup">\r
6457 <summary>\r
6458 Gets or sets the promotion in use. If a promotion group is specified, this option identifies the\r
6459 promotion group to which the revision is currently assigned. If no promotion group is specified (ie.\r
6460 this property is set to an empty string), this option indicates that one is not identifying the\r
6461 revision by promotion group.\r
6462 </summary>\r
6463 <remarks>\r
6464 <para>\r
6465 This is equivalent to the <c>-g</c> parameter to the <c>pcli put</c> command.\r
6466 </para>\r
6467 </remarks>\r
6468 </member>\r
6469 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists">\r
6470 <summary>\r
6471 Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>\r
6472 should be reassigned if it already exists.\r
6473 </summary>\r
6474 <remarks>\r
6475 <para>\r
6476 This is equivalent to the <c>-yv</c> parameter to the <c>pcli put</c> command.\r
6477 </para>\r
6478 </remarks>\r
6479 </member>\r
6480 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision">\r
6481 <summary>\r
6482 Gets or sets the revision number to use for the new revision.\r
6483 </summary>\r
6484 <remarks>\r
6485 <para>\r
6486 This is equivalent to the <c>-r</c> parameter to the <c>pcli put</c> command.\r
6487 </para>\r
6488 </remarks>\r
6489 </member>\r
6490 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription">\r
6491 <summary>\r
6492 Gets or sets a value indicating whether the same description should be used for all versioned items.\r
6493 This is <c>true</c> by default.\r
6494 </summary>\r
6495 <remarks>\r
6496 <para>\r
6497 This is equivalent to the <c>-ym</c> parameter to the <c>pcli put</c> command.\r
6498 </para>\r
6499 </remarks>\r
6500 </member>\r
6501 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel">\r
6502 <summary>\r
6503 Gets or sets the version label to assign to the new revisions.\r
6504 </summary>\r
6505 <remarks>\r
6506 <para>\r
6507 This is equivalent to the <c>-v</c> parameter to the <c>pcli put</c> command.\r
6508 </para>\r
6509 </remarks>\r
6510 </member>\r
6511 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask">\r
6512 <summary>\r
6513 Renames a label in a PVCS repository.\r
6514 </summary>\r
6515 <remarks>\r
6516 <para>\r
6517 This task uses the <c>renamelabel</c> PCLI command to rename the label.\r
6518 </para>\r
6519 </remarks>\r
6520 <example>\r
6521 <para>\r
6522 Renames the label on <c>App.ico</c> from <c>Beater</c> to <c>Beta</c> in the project database specified by\r
6523 the <c>project-database</c> property.\r
6524 </para>\r
6525 <code>\r
6526 <![CDATA[\r
6527 <pvcsrenamelabel projectdatabase="${project-database}" from="Beater" to="Beta">\r
6528 <entities>\r
6529 <entity name="App.ico"/>\r
6530 </entities>\r
6531 </pvcsrenamelabel>\r
6532 ]]>\r
6533 </code>\r
6534 </example>\r
6535 <example>\r
6536 <para>\r
6537 Renames the label on all files from <c>Alfa</c> to <c>Alpha</c> in the project database specified by the\r
6538 <c>project-database</c> property.\r
6539 </para>\r
6540 <code>\r
6541 <![CDATA[\r
6542 <pvcsrenamelabel projectdatabase="${project-database}" from="Alfa" to="Alpha" includesubprojects="true">\r
6543 <entities>\r
6544 <entity name="/"/>\r
6545 </entities>\r
6546 </pvcsrenamelabel>\r
6547 ]]>\r
6548 </code>\r
6549 </example>\r
6550 </member>\r
6551 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._from">\r
6552 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From"/>\r
6553 </member>\r
6554 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._to">\r
6555 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To"/>\r
6556 </member>\r
6557 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
6558 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
6559 </member>\r
6560 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From">\r
6561 <summary>\r
6562 Gets or sets the existing label.\r
6563 </summary>\r
6564 <remarks>\r
6565 <para>\r
6566 This is equivalent to the <c>-vf</c> parameter to the <c>pcli renamelabel</c> command.\r
6567 </para>\r
6568 </remarks>\r
6569 </member>\r
6570 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To">\r
6571 <summary>\r
6572 Gets or sets the new label.\r
6573 </summary>\r
6574 <remarks>\r
6575 <para>\r
6576 This is equivalent to the <c>-vt</c> parameter to the <c>pcli renamelabel</c> command.\r
6577 </para>\r
6578 </remarks>\r
6579 </member>\r
6580 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask">\r
6581 <summary>\r
6582 Unlocks revisions of versioned files in a PVCS repository.\r
6583 </summary>\r
6584 <remarks>\r
6585 <para>\r
6586 This task uses the <c>unlock</c> PCLI command to perform the unlock operation.\r
6587 </para>\r
6588 </remarks>\r
6589 <example>\r
6590 <para>\r
6591 Unlocks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.\r
6592 </para>\r
6593 <code>\r
6594 <![CDATA[\r
6595 <pvcsunlock projectdatabase="${project-database}">\r
6596 <entities>\r
6597 <entity name="/App.ico"/>\r
6598 </entities>\r
6599 </pvcsunlock>\r
6600 ]]>\r
6601 </code>\r
6602 </example>\r
6603 <example>\r
6604 <para>\r
6605 Unlocks all files in the project specified by the <c>project-database</c> property. Locks by all users are\r
6606 removed.\r
6607 </para>\r
6608 <code>\r
6609 <![CDATA[\r
6610 <pvcsunlock projectdatabase="${project-database}" includesubprojects="true" unlockmode="AllUsers">\r
6611 <entities>\r
6612 <entity name="/"/>\r
6613 </entities>\r
6614 </pvcsunlock>\r
6615 ]]>\r
6616 </code>\r
6617 </example>\r
6618 </member>\r
6619 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._revision">\r
6620 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision"/>\r
6621 </member>\r
6622 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._unlockMode">\r
6623 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/>\r
6624 </member>\r
6625 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._user">\r
6626 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User"/>\r
6627 </member>\r
6628 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.#ctor">\r
6629 <summary>\r
6630 Constructs and initializes an instance of <c>PVCSUnlock</c>.\r
6631 </summary>\r
6632 </member>\r
6633 <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">\r
6634 <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>\r
6635 </member>\r
6636 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision">\r
6637 <summary>\r
6638 Gets or sets the revision number to use for the new revision.\r
6639 </summary>\r
6640 <remarks>\r
6641 <para>\r
6642 This is equivalent to the <c>-r</c> parameter to the <c>pcli unlock</c> command.\r
6643 </para>\r
6644 </remarks>\r
6645 </member>\r
6646 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode">\r
6647 <summary>\r
6648 Gets or sets the unlock mode for the operation.\r
6649 </summary>\r
6650 <remarks>\r
6651 <para>\r
6652 This is equivalent to the <c>-u</c> parameter to the <c>pcli unlock</c> command.\r
6653 </para>\r
6654 </remarks>\r
6655 </member>\r
6656 <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User">\r
6657 <summary>\r
6658 Gets or sets the user whose locked files are to be unlocked. This is relevant only when\r
6659 <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/> is set to <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser"/>.\r
6660 </summary>\r
6661 </member>\r
6662 <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode">\r
6663 <summary>\r
6664 Specifies possible modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask"/> task.\r
6665 </summary>\r
6666 </member>\r
6667 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.CurrentUser">\r
6668 <summary>\r
6669 All locks held by the current user are removed.\r
6670 </summary>\r
6671 </member>\r
6672 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser">\r
6673 <summary>\r
6674 All locks held by a specified user are removed.\r
6675 </summary>\r
6676 </member>\r
6677 <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.AllUsers">\r
6678 <summary>\r
6679 All locks held by all users are removed.\r
6680 </summary>\r
6681 </member>\r
6682 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Add">\r
6683 <summary>\r
6684 Open file(s) in a client workspace for addition to the depot.\r
6685 </summary>\r
6686 <example>\r
6687 <para>\r
6688 Add all cs files under the given directory into the "new" changelist \r
6689 (will be created if it doesn't already exist).\r
6690 </para>\r
6691 <code>\r
6692 <![CDATA[\r
6693 <p4add file="C:\Src\Project\*.cs" changelist="new" />\r
6694 ]]>\r
6695 </code>\r
6696 </example>\r
6697 <example>\r
6698 <para>Add Test.txt into the default changelist.</para>\r
6699 <code>\r
6700 <![CDATA[\r
6701 <p4add file="C:\Src\Project\Test.txt" />\r
6702 ]]>\r
6703 </code>\r
6704 </example>\r
6705 </member>\r
6706 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Base">\r
6707 <summary>\r
6708 Base class for Perforce (P4) NAnt tasks. See individual task for example usage.\r
6709 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Add">P4Add</seealso>\r
6710 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Change">P4Change</seealso>\r
6711 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Delete">P4Delete</seealso>\r
6712 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Edit">P4Edit</seealso>\r
6713 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Label">P4Label</seealso>\r
6714 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">P4Labelsync</seealso>\r
6715 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Print">P4Print</seealso>\r
6716 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">P4Reopen</seealso>\r
6717 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Revert">P4Revert</seealso>\r
6718 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Submit">P4Submit</seealso>\r
6719 <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Sync">P4Sync</seealso>\r
6720 </summary>\r
6721 </member>\r
6722 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Base.ExecuteTask">\r
6723 <summary>\r
6724 Execute the perforce command assembled by subclasses.\r
6725 </summary>\r
6726 </member>\r
6727 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Port">\r
6728 <summary>\r
6729 The p4 server and port to connect to. The default is "perforce:1666".\r
6730 </summary>\r
6731 </member>\r
6732 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Client">\r
6733 <summary>\r
6734 The p4 client spec to use. The default is the current client.\r
6735 </summary>\r
6736 </member>\r
6737 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.User">\r
6738 <summary>\r
6739 The p4 username. The default is the current user.\r
6740 </summary>\r
6741 </member>\r
6742 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.View">\r
6743 <summary>\r
6744 The client, branch or label view to operate upon. The default is\r
6745 "//...".\r
6746 </summary>\r
6747 </member>\r
6748 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Script">\r
6749 <summary>\r
6750 Prepends a descriptive field (for example, text:, info:, error:, exit:) \r
6751 to each line of output produced by a Perforce command. This is most \r
6752 often used when scripting. The default is <see langword="false" />.\r
6753 </summary>\r
6754 </member>\r
6755 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ProgramArguments">\r
6756 <summary>\r
6757 Gets the command line arguments for the external program.\r
6758 </summary>\r
6759 <value>\r
6760 The command line arguments for the external program.\r
6761 </value>\r
6762 </member>\r
6763 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ExeName">\r
6764 <summary>\r
6765 Override the ExeName paramater for p4.exe\r
6766 </summary>\r
6767 </member>\r
6768 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.CommandSpecificArguments">\r
6769 <summary>\r
6770 Derived classes should override this to provide command-specific\r
6771 commandline arguments.\r
6772 </summary>\r
6773 </member>\r
6774 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Add.getSpecificCommandArguments">\r
6775 <summary>\r
6776 Build the command string for this particular command.\r
6777 </summary>\r
6778 <returns>\r
6779 The command string for this particular command.\r
6780 </returns>\r
6781 </member>\r
6782 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.File">\r
6783 <summary>\r
6784 File(s) to add. File name can contain wildcard characters. (Note: \r
6785 this is not using p4 wildcard syntax, but the OS wildcards).\r
6786 </summary>\r
6787 </member>\r
6788 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Changelist">\r
6789 <summary>\r
6790 Changelist that files will be added into. Changelist will be created \r
6791 if not already present.\r
6792 </summary>\r
6793 </member>\r
6794 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Type">\r
6795 <summary>\r
6796 File Type settings. Applied to all files in the <see cref="P:NAnt.Contrib.Tasks.Perforce.P4Add.File"/> \r
6797 parameter.\r
6798 </summary>\r
6799 </member>\r
6800 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.CommandSpecificArguments">\r
6801 <summary>\r
6802 This is an override used by the base class to get command specific args.\r
6803 </summary>\r
6804 </member>\r
6805 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Change">\r
6806 <summary>\r
6807 Create or delete a changelist specification.\r
6808 </summary>\r
6809 <example>\r
6810 <para>Create a new changelist called "mynewchange".</para>\r
6811 <code>\r
6812 <![CDATA[\r
6813 <p4change changelist="mynewchange" />\r
6814 ]]>\r
6815 </code>\r
6816 </example>\r
6817 <example>\r
6818 <para>Delete the changelist called "mynewchange".</para>\r
6819 <code>\r
6820 <![CDATA[\r
6821 <p4change changelist="mynewchange" delete="true" />\r
6822 ]]>\r
6823 </code>\r
6824 </example>\r
6825 </member>\r
6826 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Change.getSpecificCommandArguments">\r
6827 <summary>\r
6828 Builds the command string for this particular command.\r
6829 </summary>\r
6830 <returns>\r
6831 The command string for this particular command.\r
6832 </returns>\r
6833 </member>\r
6834 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Changelist">\r
6835 <summary>\r
6836 Changelist to create or delete.\r
6837 </summary>\r
6838 </member>\r
6839 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Delete">\r
6840 <summary>\r
6841 If <see langword="false" /> causes passed in changelist to be \r
6842 deleted. The default is <see langword="false" />.\r
6843 </summary>\r
6844 </member>\r
6845 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.CommandSpecificArguments">\r
6846 <summary>\r
6847 This is an override used by the base class to get command specific args.\r
6848 </summary>\r
6849 </member>\r
6850 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Client">\r
6851 <summary>\r
6852 Add/modify/delete a client spec in perforce.\r
6853 </summary>\r
6854 <example>\r
6855 <para>\r
6856 Add a client (modify if already present and have sufficient rights).\r
6857 </para>\r
6858 <code>\r
6859 <![CDATA[\r
6860 <p4client clientname="myClient" view="//root/test/..." />\r
6861 ]]>\r
6862 </code>\r
6863 </example>\r
6864 <example>\r
6865 <para>Delete a client.</para>\r
6866 <code>\r
6867 <![CDATA[\r
6868 <p4client delete="true" clientname="myClient" />\r
6869 ]]>\r
6870 </code>\r
6871 </example>\r
6872 </member>\r
6873 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Client.getSpecificCommandArguments">\r
6874 <summary>\r
6875 Builds the command string for this particular command.\r
6876 </summary>\r
6877 <returns>\r
6878 The command string for this particular command.\r
6879 </returns>\r
6880 </member>\r
6881 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.ClientName">\r
6882 <summary>\r
6883 Name of client to create/delete.\r
6884 </summary>\r
6885 </member>\r
6886 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Root">\r
6887 <summary>\r
6888 Root path for client spec.\r
6889 </summary>\r
6890 </member>\r
6891 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Delete">\r
6892 <summary>\r
6893 Delete the named client. The default is <see langword="false" />.\r
6894 </summary>\r
6895 </member>\r
6896 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Force">\r
6897 <summary>\r
6898 Force a delete even if files are open. The default is \r
6899 <see langword="false" />.\r
6900 </summary>\r
6901 </member>\r
6902 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.CommandSpecificArguments">\r
6903 <summary>\r
6904 This is an override used by the base class to get command specific args.\r
6905 </summary>\r
6906 </member>\r
6907 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Delete">\r
6908 <summary>\r
6909 Open file(s) in a client workspace for deletion from the depot.\r
6910 </summary>\r
6911 <example>\r
6912 <para>\r
6913 Mark all cs files under the give view for deletion and place them in \r
6914 the "Deleting" changelist.\r
6915 </para>\r
6916 <code>\r
6917 <![CDATA[\r
6918 <p4delete view="//Root/ProjectX/Test/...*.cs" changelist="Deleting" />\r
6919 ]]>\r
6920 </code>\r
6921 </example>\r
6922 </member>\r
6923 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Delete.getSpecificCommandArguments">\r
6924 <summary>\r
6925 Builds the command string for this particular command.\r
6926 </summary>\r
6927 <returns>\r
6928 The command string for this particular command.\r
6929 </returns>\r
6930 </member>\r
6931 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.Changelist">\r
6932 <summary>\r
6933 Changelist to place the marked for deletion item into.\r
6934 </summary>\r
6935 </member>\r
6936 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.View">\r
6937 <summary>\r
6938 The client, branch or label view to operate upon.\r
6939 </summary>\r
6940 </member>\r
6941 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.CommandSpecificArguments">\r
6942 <summary>\r
6943 This is an override used by the base class to get command specific args.\r
6944 </summary>\r
6945 </member>\r
6946 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Edit">\r
6947 <summary>\r
6948 Opens file(s) in a client workspace for edit.\r
6949 </summary>\r
6950 <example>\r
6951 <para>\r
6952 Open all files in the ProjectX Test folder for edit, and place into \r
6953 the default changelist.\r
6954 </para>\r
6955 <code>\r
6956 <![CDATA[\r
6957 <p4edit view="//Root/ProjectX/Test/..." />\r
6958 ]]>\r
6959 </code>\r
6960 </example>\r
6961 <example>\r
6962 <para>\r
6963 Open all *.txt files in the ProjectX Test folder for edit, and place \r
6964 into the "testing" changelist.\r
6965 </para>\r
6966 <code>\r
6967 <![CDATA[\r
6968 <p4edit view="//Root/ProjectX/Test/...*.txt" changelist="testing" />\r
6969 ]]>\r
6970 </code>\r
6971 </example>\r
6972 </member>\r
6973 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Edit.getSpecificCommandArguments">\r
6974 <summary>\r
6975 Builds the command string for this particular command.\r
6976 </summary>\r
6977 <returns>\r
6978 The command string for this particular command.\r
6979 </returns>\r
6980 </member>\r
6981 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Changelist">\r
6982 <summary>\r
6983 Changelist to place the opened files into.\r
6984 </summary>\r
6985 </member>\r
6986 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Type">\r
6987 <summary>\r
6988 File Type settings.\r
6989 </summary>\r
6990 </member>\r
6991 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.View">\r
6992 <summary>\r
6993 The client, branch or label view to operate upon.\r
6994 </summary>\r
6995 </member>\r
6996 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.CommandSpecificArguments">\r
6997 <summary>\r
6998 This is an override used by the base class to get command specific args.\r
6999 </summary>\r
7000 </member>\r
7001 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Info">\r
7002 <summary>\r
7003 Returns information from the "p4 info" command back into variables for \r
7004 use within the build process.\r
7005 </summary>\r
7006 <example>\r
7007 <para>Fill the variables using the task.</para>\r
7008 <code>\r
7009 <![CDATA[\r
7010 <p4info user="myuser" client="myclient" host="myhost" root="myroot" />\r
7011 <echo message="User: ${myuser} - Client: ${myclient} - Host: ${myhost} - Root: ${myroot}" />\r
7012 ]]>\r
7013 </code>\r
7014 </example>\r
7015 </member>\r
7016 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.User">\r
7017 <summary>\r
7018 The name of the property to store the p4 user name in.\r
7019 </summary>\r
7020 </member>\r
7021 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Client">\r
7022 <summary>\r
7023 The name of the property to store the p4 client name in.\r
7024 </summary>\r
7025 </member>\r
7026 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Host">\r
7027 <summary>\r
7028 The name of the property to store the p4 host name in.\r
7029 </summary>\r
7030 </member>\r
7031 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Root">\r
7032 <summary>\r
7033 The name of the property to store the p4 client root in.\r
7034 </summary>\r
7035 </member>\r
7036 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Label">\r
7037 <summary>\r
7038 Create or edit a label specification and its view.\r
7039 </summary>\r
7040 <example>\r
7041 <para>Create a new label called "SDK_V1.2".</para>\r
7042 <code>\r
7043 <![CDATA[\r
7044 <p4label label="SDK_V1.2" view="//Root/ProjectX/Test/...*.txt" />\r
7045 ]]>\r
7046 </code>\r
7047 </example>\r
7048 <example>\r
7049 <para>Delete the previously created label.</para>\r
7050 <code>\r
7051 <![CDATA[\r
7052 <p4label label="SDK_V1.2" delete="true" />\r
7053 ]]>\r
7054 </code>\r
7055 </example>\r
7056 </member>\r
7057 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Label.getSpecificCommandArguments">\r
7058 <summary>\r
7059 Builds the command string for this particular command.\r
7060 </summary>\r
7061 <returns>\r
7062 The command string for this particular command.\r
7063 </returns>\r
7064 </member>\r
7065 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Label">\r
7066 <summary>\r
7067 Name of label to create/delete.\r
7068 </summary>\r
7069 </member>\r
7070 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Delete">\r
7071 <summary>\r
7072 Delete the named label. The default is <see langword="false" />.\r
7073 </summary>\r
7074 </member>\r
7075 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.CommandSpecificArguments">\r
7076 <summary>\r
7077 This is an override used by the base class to get command specific args.\r
7078 </summary>\r
7079 </member>\r
7080 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">\r
7081 <summary>\r
7082 Synchronize a label with the contents of the current client workspace.\r
7083 </summary>\r
7084 <example>\r
7085 <para>Apply a previously created label to the specified view.</para>\r
7086 <code>\r
7087 <![CDATA[\r
7088 <p4labelsync label="SDK_V1.2" view="//Root/..." />\r
7089 ]]>\r
7090 </code>\r
7091 </example>\r
7092 </member>\r
7093 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Labelsync.getSpecificCommandArguments">\r
7094 <summary>\r
7095 Builds the command string for this particular command.\r
7096 </summary>\r
7097 <returns>\r
7098 The command string for this particular command.\r
7099 </returns>\r
7100 </member>\r
7101 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Label">\r
7102 <summary>\r
7103 Name of the label to sync the specified or default view with.\r
7104 </summary>\r
7105 </member>\r
7106 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Delete">\r
7107 <summary>\r
7108 Delete the view defined in the label, or matching the input view \r
7109 from the label. The default is <see langword="false" />.\r
7110 </summary>\r
7111 </member>\r
7112 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.CommandSpecificArguments">\r
7113 <summary>\r
7114 This is an override used by the base class to get command specific args.\r
7115 </summary>\r
7116 </member>\r
7117 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Print">\r
7118 <summary>\r
7119 Fetch a specific file from a Perforce depot without needing a clientspec \r
7120 to map it.\r
7121 </summary>\r
7122 <example>\r
7123 <code>\r
7124 <![CDATA[\r
7125 <p4print file="//depot/foo/mainline/clientspec" outputfile=".\clientspec" />\r
7126 <p4client input=".\clientspec" />\r
7127 ]]>\r
7128 </code>\r
7129 </example>\r
7130 </member>\r
7131 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Print.getSpecificCommandArguments">\r
7132 <summary>\r
7133 Builds the command string for this particular command.\r
7134 </summary>\r
7135 <returns>\r
7136 The command string for this particular command.\r
7137 </returns>\r
7138 </member>\r
7139 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.File">\r
7140 <summary> \r
7141 The depot or local filename (including optional path) of the file \r
7142 to fetch.\r
7143 </summary>\r
7144 </member>\r
7145 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.P4OutputFile">\r
7146 <summary> \r
7147 The local filename to write the fetched file to.\r
7148 </summary>\r
7149 </member>\r
7150 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.CommandSpecificArguments">\r
7151 <summary>\r
7152 This is an override used by the base class to get command specific args.\r
7153 </summary>\r
7154 </member>\r
7155 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">\r
7156 <summary>\r
7157 Move opened files between changelists or change the files’ type.\r
7158 </summary>\r
7159 <remarks>\r
7160 This task has two different but related uses:\r
7161 Moving opened files between changelists (default or named).\r
7162 Changing the type of an opened file.\r
7163 </remarks>\r
7164 <example>\r
7165 <para>\r
7166 Move the specified files matching the view into the "New" changelist.\r
7167 </para>\r
7168 <code>\r
7169 <![CDATA[\r
7170 <p4reopen view="//Root/...Version.xml" changelist="New" />\r
7171 ]]>\r
7172 </code>\r
7173 </example>\r
7174 <example>\r
7175 <para>\r
7176 Modify the specified files matching the view to the given file type. \r
7177 The change won't affect the repository until submitted.\r
7178 </para>\r
7179 <code>\r
7180 <![CDATA[\r
7181 <p4reopen view="//Root/...*.res" type="binary" />\r
7182 ]]>\r
7183 </code>\r
7184 </example>\r
7185 </member>\r
7186 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Reopen.getSpecificCommandArguments">\r
7187 <summary>\r
7188 Builds the command string for this particular command.\r
7189 </summary>\r
7190 <returns>\r
7191 The command string for this particular command.\r
7192 </returns>\r
7193 </member>\r
7194 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.View">\r
7195 <summary>\r
7196 The client, branch or label view to operate upon.\r
7197 </summary>\r
7198 </member>\r
7199 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Changelist">\r
7200 <summary>\r
7201 Changelist to place the reopened files into.\r
7202 </summary>\r
7203 </member>\r
7204 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Type">\r
7205 <summary>\r
7206 File Type settings.\r
7207 </summary>\r
7208 </member>\r
7209 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.CommandSpecificArguments">\r
7210 <summary>\r
7211 This is an override used by the base class to get command specific args.\r
7212 </summary>\r
7213 </member>\r
7214 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Revert">\r
7215 <summary>\r
7216 Discard changes made to open files.\r
7217 </summary>\r
7218 <example>\r
7219 <para>Revert all txt files in a given changelist.</para>\r
7220 <code>\r
7221 <![CDATA[\r
7222 <p4revert changelist="Test" view="//...*.txt" />\r
7223 ]]>\r
7224 </code>\r
7225 </example>\r
7226 <example>\r
7227 <para>\r
7228 Revert all unchanged files opened in the given changelist.\r
7229 </para>\r
7230 <code>\r
7231 <![CDATA[\r
7232 <p4revert changelist="Test" revertunchanged="true" />\r
7233 ]]>\r
7234 </code>\r
7235 </example>\r
7236 <example>\r
7237 <para>Revert all unchanged files opened in any changelist.</para>\r
7238 <code>\r
7239 <![CDATA[\r
7240 <p4revert revertunchanged="true" />\r
7241 ]]>\r
7242 </code>\r
7243 </example>\r
7244 </member>\r
7245 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Revert.getSpecificCommandArguments">\r
7246 <summary>\r
7247 Builds the command string for this particular command.\r
7248 </summary>\r
7249 <returns>\r
7250 The command string for this particular command.\r
7251 </returns>\r
7252 </member>\r
7253 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.Changelist">\r
7254 <summary>\r
7255 Changelist to perform the revert action on. optional.\r
7256 </summary>\r
7257 </member>\r
7258 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.RevertUnchanged">\r
7259 <summary>\r
7260 Revert all unchanged or missing files from the changelist. default is false. optional.\r
7261 </summary>\r
7262 </member>\r
7263 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.CommandSpecificArguments">\r
7264 <summary>\r
7265 This is an override used by the base class to get command specific args.\r
7266 </summary>\r
7267 </member>\r
7268 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Set">\r
7269 <summary>\r
7270 Set registry variables that perforce uses.\r
7271 </summary>\r
7272 <remarks>\r
7273 Note: the environment variables that p4 uses will be set, but will not\r
7274 be validated.\r
7275 </remarks>\r
7276 <example>\r
7277 <para>Modify any of the three variables (at least one required).</para>\r
7278 <code>\r
7279 <![CDATA[\r
7280 <p4set client="myClient" user="jonb" port="server:1666" />\r
7281 ]]>\r
7282 </code>\r
7283 </example>\r
7284 </member>\r
7285 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Set.getSpecificCommandArguments">\r
7286 <summary>\r
7287 Builds the command string for this particular command.\r
7288 </summary>\r
7289 <returns>\r
7290 The command string for this particular command.\r
7291 </returns>\r
7292 </member>\r
7293 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Set.CommandSpecificArguments">\r
7294 <summary>\r
7295 This is an override used by the base class to get command specific args.\r
7296 </summary>\r
7297 </member>\r
7298 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Submit">\r
7299 <summary>\r
7300 Send changes made to open files to the depot.\r
7301 </summary>\r
7302 <example>\r
7303 <para>\r
7304 Submit changelist "Temp", but first revert all unchanged files in the \r
7305 changelist.\r
7306 </para>\r
7307 <code>\r
7308 <![CDATA[\r
7309 <p4submit changelist="Temp" revertunchanged="true" />\r
7310 ]]>\r
7311 </code>\r
7312 </example>\r
7313 <example>\r
7314 <para>Submit changelist, but leave the files open afterwards.</para>\r
7315 <code>\r
7316 <![CDATA[\r
7317 <p4submit changelist="Temp" remainopen="true" />\r
7318 ]]>\r
7319 </code>\r
7320 </example>\r
7321 </member>\r
7322 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Submit.getSpecificCommandArguments">\r
7323 <summary>\r
7324 Builds the command string for this particular command.\r
7325 </summary>\r
7326 <returns>\r
7327 The command string for this particular command.\r
7328 </returns>\r
7329 </member>\r
7330 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.Changelist">\r
7331 <summary>\r
7332 Changelist to submit.\r
7333 </summary>\r
7334 </member>\r
7335 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RemainOpen">\r
7336 <summary>\r
7337 Keep the files open after submitting. The default is \r
7338 <see langword="false" />.\r
7339 </summary>\r
7340 </member>\r
7341 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RevertUnchanged">\r
7342 <summary>\r
7343 Revert all unchanged or missing files from the changelist.\r
7344 The default is <see langword="false" />.\r
7345 </summary>\r
7346 </member>\r
7347 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.CommandSpecificArguments">\r
7348 <summary>\r
7349 This is an override used by the base class to get command specific args.\r
7350 </summary>\r
7351 </member>\r
7352 <member name="T:NAnt.Contrib.Tasks.Perforce.P4Sync">\r
7353 <summary>\r
7354 Synchronize client space to a Perforce depot view.\r
7355 </summary> \r
7356 <example>\r
7357 <para>\r
7358 Sync to head using P4USER, P4PORT and P4CLIENT settings specified.\r
7359 </para>\r
7360 <code>\r
7361 <![CDATA[\r
7362 <p4Sync \r
7363 view="//projects/foo/main/source/..."\r
7364 user="fbloggs"\r
7365 port="km01:1666"\r
7366 client="fbloggsclient"\r
7367 />\r
7368 ]]>\r
7369 </code>\r
7370 </example>\r
7371 <example>\r
7372 <para>Sync to head using default p4 environment variables.</para>\r
7373 <code>\r
7374 <![CDATA[\r
7375 <p4sync view="//projects/foo/main/source/..." />\r
7376 ]]>\r
7377 </code>\r
7378 </example>\r
7379 <example>\r
7380 <para>Force a re-sync to head, refreshing all files.</para>\r
7381 <code>\r
7382 <![CDATA[\r
7383 <p4sync force="true" view="//projects/foo/main/source/..." />\r
7384 ]]>\r
7385 </code>\r
7386 </example>\r
7387 <example>\r
7388 <para>Sync to a label.</para>\r
7389 <code>\r
7390 <![CDATA[\r
7391 <p4sync label="myPerforceLabel" />\r
7392 ]]>\r
7393 </code>\r
7394 </example>\r
7395 </member>\r
7396 <member name="M:NAnt.Contrib.Tasks.Perforce.P4Sync.getSpecificCommandArguments">\r
7397 <summary>\r
7398 Builds the command string for this particular command.\r
7399 </summary>\r
7400 <returns>\r
7401 The command string for this particular command.\r
7402 </returns>\r
7403 </member>\r
7404 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Label">\r
7405 <summary> Label to sync client to; optional.\r
7406 </summary>\r
7407 </member>\r
7408 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Force">\r
7409 <summary>\r
7410 Force a refresh of files. The default is <see langword="false" />.\r
7411 </summary>\r
7412 </member>\r
7413 <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.CommandSpecificArguments">\r
7414 <summary>\r
7415 This is an override used by the base class to get command specific args.\r
7416 </summary>\r
7417 </member>\r
7418 <member name="T:NAnt.Contrib.Tasks.Perforce.Perforce">\r
7419 <summary>\r
7420 Static helper class for Perforce tasks.\r
7421 </summary>\r
7422 </member>\r
7423 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetUserName">\r
7424 <summary>\r
7425 ask p4 for the user name\r
7426 </summary>\r
7427 <returns></returns>\r
7428 </member>\r
7429 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetClient">\r
7430 <summary>\r
7431 ask p4 for the client name\r
7432 </summary>\r
7433 <returns></returns>\r
7434 </member>\r
7435 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String,System.Boolean)">\r
7436 <summary>\r
7437 Get a changelist number based on on its name\r
7438 </summary>\r
7439 <param name="User"></param>\r
7440 <param name="Client"></param>\r
7441 <param name="ChangeList"></param>\r
7442 <param name="CreateIfMissing"></param>\r
7443 <returns></returns>\r
7444 </member>\r
7445 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String)">\r
7446 <summary>\r
7447 Get a changelist number based on on its name\r
7448 </summary>\r
7449 <param name="User"></param>\r
7450 <param name="Client"></param>\r
7451 <param name="ChangeList"></param>\r
7452 <returns></returns>\r
7453 </member>\r
7454 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateLabel(System.String,System.String,System.String)">\r
7455 <summary>\r
7456 Create a new label\r
7457 </summary>\r
7458 <param name="User"></param>\r
7459 <param name="Labelname"></param>\r
7460 <param name="View"></param>\r
7461 </member>\r
7462 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateClient(System.String,System.String,System.String,System.String)">\r
7463 <summary>\r
7464 Create a new Client\r
7465 </summary>\r
7466 <param name="User"></param>\r
7467 <param name="Clientname"></param>\r
7468 <param name="Root"></param>\r
7469 <param name="View"></param>\r
7470 </member>\r
7471 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateChangelist(System.String,System.String,System.String)">\r
7472 <summary>\r
7473 Create a new changelist\r
7474 </summary>\r
7475 <param name="User"></param>\r
7476 <param name="Client"></param>\r
7477 <param name="ChangeList">Description of Changelist</param>\r
7478 <returns></returns>\r
7479 </member>\r
7480 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String)">\r
7481 <summary>\r
7482 call the p4 process to \r
7483 </summary>\r
7484 <param name="SearchPattern"></param>\r
7485 <returns></returns>\r
7486 </member>\r
7487 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String[])">\r
7488 <summary>\r
7489 call the p4 process to \r
7490 </summary>\r
7491 <param name="SearchPatterns"></param>\r
7492 <returns></returns>\r
7493 </member>\r
7494 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.getProcessOutput(System.String,System.String,System.String)">\r
7495 <summary>\r
7496 Execute a process and return its ourput\r
7497 </summary>\r
7498 <param name="exe"></param>\r
7499 <param name="prms"></param>\r
7500 <param name="input"></param>\r
7501 <returns></returns>\r
7502 </member>\r
7503 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String,System.String@)">\r
7504 <summary>\r
7505 Execute a process and return its ourput\r
7506 </summary>\r
7507 <param name="exe"></param>\r
7508 <param name="prms"></param>\r
7509 <param name="input"></param>\r
7510 <param name="output"></param>\r
7511 <returns></returns>\r
7512 </member>\r
7513 <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String)">\r
7514 <summary>\r
7515 Execute a process by name\r
7516 </summary>\r
7517 <param name="exe"></param>\r
7518 <param name="prms"></param>\r
7519 <param name="input"></param>\r
7520 <returns></returns>\r
7521 </member>\r
7522 <member name="T:NAnt.Contrib.Tasks.SourceSafe.AddTask">\r
7523 <summary>\r
7524 Used to add files to a Visual SourceSafe database. If the file is currently\r
7525 in the SourceSafe database a message will be logged but files will continue to be added.\r
7526 </summary>\r
7527 <remarks>\r
7528 This version does not support recursive adds. Only adds in the root directory will be added to the\r
7529 SourceSafe database.\r
7530 </remarks>\r
7531 <example>\r
7532 <code><![CDATA[\r
7533 <vssadd dbpath="C:\SourceSafeFolder\srcsafe.ini" user="user1" password="" path="$/Somefolder">\r
7534 <fileset basedir="C:\SourceFolder\">\r
7535 <include name="*.dll"/>\r
7536 </fileset>\r
7537 </vssadd>\r
7538 ]]></code>\r
7539 </example>\r
7540 </member>\r
7541 <member name="T:NAnt.Contrib.Tasks.SourceSafe.BaseTask">\r
7542 <summary>\r
7543 The base abstract class for all Visual Source Safe Tasks. \r
7544 Provides the core attributes, and functionality for opening an item \r
7545 in a Visual Source Safe database.\r
7546 </summary>\r
7547 </member>\r
7548 <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Open">\r
7549 <summary>\r
7550 Opens the Source Safe database and sets the reference to the specified\r
7551 item and version.\r
7552 </summary>\r
7553 </member>\r
7554 <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.GetFileTimestampFlags(NAnt.Contrib.Tasks.SourceSafe.FileTimestamp)">\r
7555 <summary>\r
7556 Gets the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value corresponding with the \r
7557 specified <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.\r
7558 </summary>\r
7559 <param name="timestamp">A <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.</param>\r
7560 <returns>\r
7561 An <see cref="T:System.Int32"/> representing the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value\r
7562 for the <paramref name="timestamp"/>.\r
7563 </returns>\r
7564 </member>\r
7565 <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.DBPath">\r
7566 <summary>\r
7567 The path to the folder that contains "srcsafe.ini".\r
7568 </summary>\r
7569 </member>\r
7570 <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Path">\r
7571 <summary>\r
7572 The Visual SourceSafe project or file path you wish the perform the\r
7573 action on (starting with "$/").\r
7574 </summary>\r
7575 </member>\r
7576 <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Password">\r
7577 <summary>\r
7578 The password to use to login to the SourceSafe database.\r
7579 </summary>\r
7580 </member>\r
7581 <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName">\r
7582 <summary>\r
7583 The name of the user needed to access the Visual SourceSafe database.\r
7584 When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network\r
7585 name for automatic user log in" is enabled for the Visual SourceSafe\r
7586 database, then the current Windows username will be used to log in.\r
7587 </summary>\r
7588 </member>\r
7589 <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Login">\r
7590 <summary>\r
7591 The name of the user needed to access the Visual SourceSafe database.\r
7592 When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network\r
7593 name for automatic user log in" is enabled, then the current\r
7594 Windows username will be used to log in.\r
7595 </summary>\r
7596 </member>\r
7597 <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Version">\r
7598 <summary>\r
7599 A version of the path to reference. Accepts multiple forms, \r
7600 including the label, version number, or date of the version. \r
7601 If omitted, the latest version is used.\r
7602 </summary>\r
7603 </member>\r
7604 <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.ExecuteTask">\r
7605 <summary>\r
7606 Main task execution method\r
7607 </summary>\r
7608 </member>\r
7609 <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.CreateProjectPath(System.String)">\r
7610 <summary>\r
7611 Create project hierarchy in vss\r
7612 </summary>\r
7613 <param name="file"></param>\r
7614 <returns></returns>\r
7615 </member>\r
7616 <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.Comment">\r
7617 <summary>\r
7618 Places a comment on all files added into the SourceSafe repository.\r
7619 </summary>\r
7620 </member>\r
7621 <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.AddFileSet">\r
7622 <summary>\r
7623 List of files that should be added to SourceSafe.\r
7624 </summary>\r
7625 </member>\r
7626 <member name="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp">\r
7627 <summary>\r
7628 Defines how the local timestamp of files retrieved from a SourceSafe\r
7629 database should be set.\r
7630 </summary>\r
7631 </member>\r
7632 <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Current">\r
7633 <summary>\r
7634 The timestamp of the local file is set to the current date and time.\r
7635 </summary>\r
7636 </member>\r
7637 <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Modified">\r
7638 <summary>\r
7639 The timestamp of the local file is set to the file's last \r
7640 modification date and time. \r
7641 </summary>\r
7642 </member>\r
7643 <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Updated">\r
7644 <summary>\r
7645 The timestamp of the local file is set to the date and time that \r
7646 the file was last checked in to the database.\r
7647 </summary>\r
7648 </member>\r
7649 <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckinTask">\r
7650 <summary>\r
7651 Used to checkin files into Visual Source Safe.\r
7652 </summary>\r
7653 <example>\r
7654 <para>Checkin all files from an absolute directory to a local sourcesafe database.</para>\r
7655 <code><![CDATA[\r
7656 <vsscheckin \r
7657 user="myusername" \r
7658 password="mypassword" \r
7659 localpath="C:\Dev\Latest"\r
7660 recursive="true"\r
7661 writable="true"\r
7662 dbpath="C:\VSS\srcsafe.ini"\r
7663 path="$/MyProduct"\r
7664 comment="NAnt checkin"\r
7665 />\r
7666 ]]></code>\r
7667 </example>\r
7668 <example>\r
7669 <para>Checkin a file from a relative directory to a remote sourcesafe database.</para>\r
7670 <code><![CDATA[\r
7671 <vsscheckin \r
7672 user="myusername" \r
7673 password="mypassword" \r
7674 localpath="Latest\myFile.cs"\r
7675 recursive="false"\r
7676 writable="true"\r
7677 dbpath="\\MyServer\VSS\srcsafe.ini"\r
7678 path="$/MyProduct/myFile.cs"\r
7679 comment="NAnt checkin"\r
7680 />\r
7681 ]]></code>\r
7682 </example>\r
7683 </member>\r
7684 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Comment">\r
7685 <summary>\r
7686 The comment for the new version.\r
7687 </summary>\r
7688 </member>\r
7689 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.LocalPath">\r
7690 <summary>\r
7691 The path to the local working directory.\r
7692 </summary>\r
7693 </member>\r
7694 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Recursive">\r
7695 <summary>\r
7696 Determines whether to perform a recursive checkin. \r
7697 The default is <see langword="true" />.\r
7698 </summary>\r
7699 </member>\r
7700 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Writable">\r
7701 <summary>\r
7702 Determines whether to leave the file(s) as writable. \r
7703 The default is <see langword="false" />.\r
7704 </summary>\r
7705 </member>\r
7706 <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask">\r
7707 <summary>\r
7708 Task used to checkout files from Visual Source Safe.\r
7709 </summary>\r
7710 <example>\r
7711 <para>Checkout the latest files from a local sourcesafe database.</para>\r
7712 <code><![CDATA[\r
7713 <vsscheckout \r
7714 user="myusername" \r
7715 password="mypassword" \r
7716 localpath="C:\Dev\Latest"\r
7717 recursive="true"\r
7718 writable="true"\r
7719 dbpath="C:\VSS\srcsafe.ini"\r
7720 path="$/MyProduct"\r
7721 />\r
7722 ]]></code>\r
7723 </example>\r
7724 <example>\r
7725 <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>\r
7726 <code><![CDATA[\r
7727 <vsscheckout \r
7728 user="myusername" \r
7729 password="mypassword" \r
7730 localpath="Latest"\r
7731 recursive="false"\r
7732 writable="true"\r
7733 dbpath="\\MyServer\VSS\srcsafe.ini"\r
7734 path="$/MyProduct/myFile.cs"\r
7735 />\r
7736 ]]></code>\r
7737 </example>\r
7738 </member>\r
7739 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.LocalPath">\r
7740 <summary>\r
7741 The path to the local working directory.\r
7742 </summary>\r
7743 </member>\r
7744 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Recursive">\r
7745 <summary>\r
7746 Determines whether to perform a recursive checkout.\r
7747 The default is <see langword="true" />.\r
7748 </summary>\r
7749 </member>\r
7750 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Writable">\r
7751 <summary>\r
7752 Determines whether to leave the file(s) as writable. \r
7753 The default is <see langword="true" />.\r
7754 </summary>\r
7755 </member>\r
7756 <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.FileTimestamp">\r
7757 <summary>\r
7758 Set the behavior for timestamps of local files. The default is\r
7759 <see cref="F:FileTimestamp.Current" />.\r
7760 </summary>\r
7761 </member>\r
7762 <member name="T:NAnt.Contrib.Tasks.SourceSafe.DiffTask">\r
7763 <summary>\r
7764 Used to generate differences in a vss database. It will show all changes to a project\r
7765 after the specified label.\r
7766 </summary>\r
7767 <remarks>\r
7768 This only shows differences between the current version and the version specified.\r
7769 </remarks>\r
7770 <example>\r
7771 <code><![CDATA[\r
7772 <vssdiff\r
7773 dbpath='ss.ini'\r
7774 path='$/My Project'\r
7775 label='My Label'\r
7776 user='ssuser'\r
7777 outputfile='diff.xml'\r
7778 />\r
7779 ]]></code>\r
7780 </example>\r
7781 </member>\r
7782 <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.Label">\r
7783 <summary>\r
7784 The value of the label to compare to. Required.\r
7785 </summary>\r
7786 </member>\r
7787 <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.OutputFile">\r
7788 <summary>\r
7789 The output file to generate (xml)\r
7790 </summary>\r
7791 </member>\r
7792 <member name="T:NAnt.Contrib.Tasks.SourceSafe.GetTask">\r
7793 <summary>\r
7794 Used to retrieve an item or project from a Visual Source Safe database.\r
7795 </summary>\r
7796 <example>\r
7797 <para>Get the latest files from a local sourcesafe database.</para>\r
7798 <code><![CDATA[\r
7799 <vssget\r
7800 user="myusername"\r
7801 password="mypassword"\r
7802 localpath="C:\Dev\Latest"\r
7803 recursive="true"\r
7804 replace="true"\r
7805 writable="true"\r
7806 dbpath="C:\VSS\srcsafe.ini"\r
7807 path="$/MyProduct"\r
7808 />\r
7809 ]]></code>\r
7810 </example>\r
7811 <example>\r
7812 <para>Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory.</para>\r
7813 <code><![CDATA[\r
7814 <vssget\r
7815 user="myusername"\r
7816 password="mypassword"\r
7817 localpath="Latest"\r
7818 recursive="true"\r
7819 replace="true"\r
7820 writable="true"\r
7821 dbpath="\\MyServer\VSS\srcsafe.ini"\r
7822 path="$/MyProduct/myFile.cs"\r
7823 />\r
7824 ]]></code>\r
7825 </example>\r
7826 <example>\r
7827 <para>Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image.</para>\r
7828 <code><![CDATA[\r
7829 <vssget\r
7830 user="myusername"\r
7831 password="mypassword"\r
7832 localpath="C:\Dev\Latest"\r
7833 recursive="true"\r
7834 replace="true"\r
7835 writable="true"\r
7836 removedeleted="true"\r
7837 dbpath="\\MyServer\VSS\srcsafe.ini"\r
7838 path="$/MyProduct/myFile.cs"\r
7839 />\r
7840 ]]></code>\r
7841 </example>\r
7842 </member>\r
7843 <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage">\r
7844 <summary>\r
7845 Checks to see if we should remove local copies of deleted files, and starts\r
7846 the scan.\r
7847 </summary>\r
7848 </member>\r
7849 <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage(SourceSafeTypeLib.IVSSItem,System.String)">\r
7850 <summary>\r
7851 Scans the Project Item for deleted files and removes their local\r
7852 copies from the local image of the project. Obeys the recursive setting\r
7853 (and thus optionally calls itself recursively).\r
7854 </summary>\r
7855 <param name="item">The VSS Item (project) to check for deletions</param>\r
7856 <param name="localPathPrefix">The path to the folder of the item being processed</param>\r
7857 </member>\r
7858 <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.LocalPath">\r
7859 <summary>\r
7860 The path to the local working directory.\r
7861 </summary>\r
7862 </member>\r
7863 <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Recursive">\r
7864 <summary>\r
7865 Determines whether to perform the get recursively.\r
7866 The default is <see langword="true" />.\r
7867 </summary>\r
7868 </member>\r
7869 <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Replace">\r
7870 <summary>\r
7871 Determines whether to replace writable files.\r
7872 The default is <see langword="false" />.\r
7873 </summary>\r
7874 </member>\r
7875 <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Writable">\r
7876 <summary>\r
7877 Determines whether the files will be writable.\r
7878 The default is <see langword="false" />.\r
7879 </summary>\r
7880 </member>\r
7881 <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeleted">\r
7882 <summary>\r
7883 Determines whether files marked "deleted" in the\r
7884 repository will be removed from the local copy.\r
7885 The default is <see langword="false" />.\r
7886 </summary>\r
7887 </member>\r
7888 <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.UseModificationTime">\r
7889 <summary>\r
7890 Determines whether the timestamp on the local copy\r
7891 will be the modification time (if false or omitted, \r
7892 the checkout time will be used)\r
7893 </summary>\r
7894 </member>\r
7895 <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.FileTimestamp">\r
7896 <summary>\r
7897 Set the behavior for timestamps of local files. The default is\r
7898 <see cref="F:FileTimestamp.Current" />.\r
7899 </summary>\r
7900 </member>\r
7901 <member name="T:NAnt.Contrib.Tasks.SourceSafe.History">\r
7902 <summary>\r
7903 Generates an XML file showing all changes made to a Visual SourceSafe\r
7904 project/file between specified labels or dates (by a given user).\r
7905 </summary>\r
7906 <example>\r
7907 <para>\r
7908 Write all changes between "Release1" and "Release2" to XML file \r
7909 "changelog.xml".\r
7910 </para>\r
7911 <code>\r
7912 <![CDATA[\r
7913 <vsshistory\r
7914 dbpath="C:\VSS\srcsafe.ini"\r
7915 path="$/My Project"\r
7916 fromlabel="Release1"\r
7917 tolabel="Release2"\r
7918 output="changelog.xml" />\r
7919 ]]>\r
7920 </code>\r
7921 </example>\r
7922 <example>\r
7923 <para>\r
7924 Write all changes between January 1st 2004 and March 31st 2004 to XML \r
7925 file "history.xml".\r
7926 </para>\r
7927 <code>\r
7928 <![CDATA[\r
7929 <vsshistory\r
7930 dbpath="C:\VSS\srcsafe.ini"\r
7931 path="$/My Project"\r
7932 fromdate="01/01/2004"\r
7933 todate="03/31/2004"\r
7934 output="history.xml"\r
7935 />\r
7936 ]]>\r
7937 </code>\r
7938 </example>\r
7939 </member>\r
7940 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromLabel">\r
7941 <summary>\r
7942 The value of the label to start comparing to. If it is not included, \r
7943 the compare will start with the very first history item.\r
7944 </summary>\r
7945 </member>\r
7946 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToLabel">\r
7947 <summary>\r
7948 The value of the label to compare up to. If it is not included,\r
7949 the compare will end with the last history item.\r
7950 </summary>\r
7951 </member>\r
7952 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromDate">\r
7953 <summary>\r
7954 Start date for comparison.\r
7955 </summary>\r
7956 </member>\r
7957 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToDate">\r
7958 <summary>\r
7959 End date for comparison.\r
7960 </summary>\r
7961 </member>\r
7962 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Output">\r
7963 <summary>\r
7964 Output file to save history to (as XML).\r
7965 </summary>\r
7966 </member>\r
7967 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Recursive">\r
7968 <summary>\r
7969 Determines whether to perform the comparison recursively.\r
7970 The default is <see langword="true" />.\r
7971 </summary>\r
7972 </member>\r
7973 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.User">\r
7974 <summary>\r
7975 Name of the user whose changes you want to see.\r
7976 </summary>\r
7977 </member>\r
7978 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.VersionFlags">\r
7979 <summary>\r
7980 Gets the flags that should be used to retrieve the history of\r
7981 <see cref="T:System.IO.Path"/>.\r
7982 </summary>\r
7983 </member>\r
7984 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Login">\r
7985 <summary>\r
7986 Override to avoid exposing the corresponding attribute to build \r
7987 authors.\r
7988 </summary>\r
7989 </member>\r
7990 <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Version">\r
7991 <summary>\r
7992 Override to avoid exposing the corresponding attribute to build \r
7993 authors.\r
7994 </summary>\r
7995 </member>\r
7996 <member name="T:NAnt.Contrib.Tasks.SourceSafe.LabelTask">\r
7997 <summary>\r
7998 Used to apply a label to a Visual Source Safe item.\r
7999 </summary>\r
8000 <example>\r
8001 <para>Label all files in a local sourcesafe database. (Automatically applies the label recursively)</para>\r
8002 <code><![CDATA[\r
8003 <vsslabel \r
8004 user="myusername" \r
8005 password="mypassword" \r
8006 dbpath="C:\VSS\srcsafe.ini"\r
8007 path="$/MyProduct"\r
8008 comment="NAnt label"\r
8009 label="myLabel"\r
8010 />\r
8011 ]]></code>\r
8012 </example>\r
8013 <example>\r
8014 <para>Label a file in a remote sourcesafe database.</para>\r
8015 <code><![CDATA[\r
8016 <vsslabel \r
8017 user="myusername" \r
8018 password="mypassword" \r
8019 dbpath="\\MyServer\VSS\srcsafe.ini"\r
8020 path="$/MyProduct/myFile.cs"\r
8021 comment="NAnt label"\r
8022 label="myLabel"\r
8023 />\r
8024 ]]></code>\r
8025 </example>\r
8026 </member>\r
8027 <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Comment">\r
8028 <summary>\r
8029 The label comment.\r
8030 </summary>\r
8031 </member>\r
8032 <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Label">\r
8033 <summary>\r
8034 The name of the label.\r
8035 </summary>\r
8036 </member>\r
8037 <member name="T:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask">\r
8038 <summary>\r
8039 Task is used to undo a checkout from SourceSafe\r
8040 </summary>\r
8041 <example>\r
8042 <para>Undo a checkout of all of the files from a local sourcesafe database.</para>\r
8043 <code><![CDATA[\r
8044 <vssundocheckout \r
8045 user="myusername" \r
8046 password="mypassword" \r
8047 localpath="C:\Dev\Latest"\r
8048 recursive="true"\r
8049 dbpath="C:\VSS\srcsafe.ini"\r
8050 path="$/MyProduct"\r
8051 />\r
8052 ]]></code>\r
8053 </example>\r
8054 <example>\r
8055 <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>\r
8056 <code><![CDATA[\r
8057 <vssundocheckout \r
8058 user="myusername" \r
8059 password="mypassword" \r
8060 localpath="Latest"\r
8061 recursive="false"\r
8062 dbpath="\\MyServer\VSS\srcsafe.ini"\r
8063 path="$/MyProduct/myFile.cs"\r
8064 />\r
8065 ]]></code>\r
8066 </example>\r
8067 </member>\r
8068 <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.LocalPath">\r
8069 <summary>\r
8070 The path to the local working directory. This is required if you wish to \r
8071 have your local file replaced with the latest version from SourceSafe.\r
8072 </summary>\r
8073 </member>\r
8074 <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.Recursive">\r
8075 <summary>\r
8076 Determines whether to perform a recursive undo of the checkout.\r
8077 The default is <see langword="true" />.\r
8078 </summary>\r
8079 </member>\r
8080 <member name="T:NAnt.Contrib.Tasks.StarTeam.LabelTask">\r
8081 <summary>\r
8082 Allows creation of view labels in StarTeam repositories.\r
8083 </summary>\r
8084 <remarks>\r
8085 <para>Often when building projects you wish to label the source control repository.</para>\r
8086 <para>By default this task creates view labels with the build option turned on.</para>\r
8087 <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel </para>\r
8088 <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>\r
8089 </remarks>\r
8090 <example>\r
8091 <para>Creates a label in a StarTeam repository.</para>\r
8092 <code>\r
8093 <![CDATA[\r
8094 <!-- \r
8095 constructs a 'url' containing connection information to pass to the task \r
8096 alternatively you can set each attribute manually \r
8097 -->\r
8098 <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />\r
8099 <stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />\r
8100 ]]>\r
8101 </code>\r
8102 </example>\r
8103 </member>\r
8104 <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamTask">\r
8105 <summary>\r
8106 Base star team task.\r
8107 </summary>\r
8108 <remarks>\r
8109 <para> \r
8110 Common super class for all StarTeam tasks. At this level of the hierarchy we are concerned only with obtaining a\r
8111 connection to the StarTeam server. The subclass <see cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>, abstracts tree-walking \r
8112 behavior common to many subtasks.\r
8113 </para>\r
8114 <para>This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html </para>\r
8115 <para>You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.</para>\r
8116 </remarks>\r
8117 <seealso cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>\r
8118 <author> <a href="mailto:jcyip@thoughtworks.com">Jason Yip</a></author>\r
8119 <author> <a href="mailto:stevec@ignitesports.com">Steve Cohen</a></author>\r
8120 </member>\r
8121 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._username">\r
8122 <value> The username of the connection</value>\r
8123 </member>\r
8124 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._password">\r
8125 <value> The username of the connection</value>\r
8126 </member>\r
8127 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._servername">\r
8128 <value> name of Starteam server to connect to</value>\r
8129 </member>\r
8130 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._serverport">\r
8131 <value> port of Starteam server to connect to</value>\r
8132 </member>\r
8133 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._projectname">\r
8134 <value> name of Starteam project to connect to</value>\r
8135 </member>\r
8136 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._viewname">\r
8137 <value> name of Starteam view to connect to</value>\r
8138 </member>\r
8139 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._server">\r
8140 <value>The starteam server through which all activities will be done.</value>\r
8141 </member>\r
8142 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)">\r
8143 <summary>\r
8144 Derived classes must override this method to instantiate a view configured appropriately to its task.\r
8145 </summary>\r
8146 <param name="rawview">the unconfigured <code>View</code></param>\r
8147 <returns>the view appropriately configured.</returns>\r
8148 </member>\r
8149 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.openView">\r
8150 <summary>\r
8151 All tasks will call on this method to connect to StarTeam and open the view for processing. \r
8152 </summary>\r
8153 <returns>the a view to be used for processing.</returns>\r
8154 <seealso cref="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)"/>\r
8155 </member>\r
8156 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.getUserName(System.Int32)">\r
8157 <summary> Returns the name of the user or a blank string if the user is not found.</summary>\r
8158 <param name="userID">a user's ID</param>\r
8159 <returns>the name of the user</returns>\r
8160 </member>\r
8161 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername">\r
8162 <summary>\r
8163 Name of StarTeamServer.\r
8164 </summary>\r
8165 <remarks>\r
8166 Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all \r
8167 connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.\r
8168 </remarks>\r
8169 </member>\r
8170 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport">\r
8171 <summary>\r
8172 Port number of the StarTeam connection.\r
8173 </summary>\r
8174 <remarks>\r
8175 Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all \r
8176 connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.\r
8177 </remarks>\r
8178 </member>\r
8179 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname">\r
8180 <summary>\r
8181 The name of the StarTeam project to be acted on\r
8182 </summary>\r
8183 <remarks>\r
8184 Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all \r
8185 connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.\r
8186 </remarks>\r
8187 </member>\r
8188 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname">\r
8189 <summary>\r
8190 The name of the StarTeam view to be acted on.\r
8191 </summary>\r
8192 <remarks>\r
8193 Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all \r
8194 connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.\r
8195 </remarks>\r
8196 </member>\r
8197 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username">\r
8198 <summary>\r
8199 The StarTeam user name used for login.\r
8200 </summary>\r
8201 <remarks>\r
8202 Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all \r
8203 connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.\r
8204 </remarks>\r
8205 </member>\r
8206 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password">\r
8207 <summary> \r
8208 The password used for login.\r
8209 </summary>\r
8210 <remarks>\r
8211 Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all \r
8212 connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.\r
8213 </remarks>\r
8214 </member>\r
8215 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url">\r
8216 <summary> \r
8217 One stop to set all parameters needed to connect to a StarTeam server.\r
8218 </summary>\r
8219 <remarks>\r
8220 <para>If you do not wish to specify a url you can set each parameter individually. \r
8221 You must set all connection parameters for the task to be able to connect to the StarTeam server.</para>\r
8222 </remarks>\r
8223 <example>\r
8224 <para>Here is how to configure the url string.</para>\r
8225 <code>servername:portnum/project/view</code>\r
8226 <para>You can optionally specify a username and password.</para>\r
8227 <code>username:password@servername:portnum/project/view</code>\r
8228 </example>\r
8229 <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername"/>\r
8230 <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport"/>\r
8231 <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname"/>\r
8232 <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname"/>\r
8233 <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username"/>\r
8234 <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password"/>\r
8235 </member>\r
8236 <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelName">\r
8237 <summary> The name of the label to be set in Starteam.</summary>\r
8238 </member>\r
8239 <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._description">\r
8240 <summary> The label description to be set in Starteam.</summary>\r
8241 </member>\r
8242 <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isBuildLabel">\r
8243 <summary> Is the label being created a build label.</summary>\r
8244 </member>\r
8245 <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelAsOfDate">\r
8246 <summary> If set the datetime to set the label as of.</summary>\r
8247 </member>\r
8248 <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isAsOfDateSet">\r
8249 <summary> Kludgy flag to keep track if date has been set. \r
8250 Please kill this if you can. Here based on experiences I have had with VB.NET</summary>\r
8251 </member>\r
8252 <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isRevision">\r
8253 <summary> Does user wish to make a revision label?</summary>\r
8254 </member>\r
8255 <member name="M:NAnt.Contrib.Tasks.StarTeam.LabelTask.createSnapshotView(StarTeam.StView)">\r
8256 <summary> \r
8257 Override of base-class abstract function creates an appropriately configured view. \r
8258 For labels this a view configured as of this.lastBuild.\r
8259 </summary>\r
8260 <param name="raw">the unconfigured <code>View</code></param>\r
8261 <returns>the snapshot <code>View</code> appropriately configured.</returns>\r
8262 </member>\r
8263 <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label">\r
8264 <summary> \r
8265 The name to be given to the label; required.\r
8266 </summary>\r
8267 </member>\r
8268 <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel">\r
8269 <summary> Should label be marked build : default is true</summary>\r
8270 </member>\r
8271 <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel">\r
8272 <summary> \r
8273 Should label created be a revision label. The default is \r
8274 <see langword="false"/>.\r
8275 </summary>\r
8276 <remarks>\r
8277 <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel"/> has no effect if this is set to <see langword="true"/>\r
8278 as revision labels cannot have a build status.\r
8279 </remarks>\r
8280 </member>\r
8281 <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Description">\r
8282 <summary> Optional description of the label to be stored in the StarTeam project.</summary>\r
8283 </member>\r
8284 <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.LastBuild">\r
8285 <summary> \r
8286 Optional: If this property is set the label will be created as of the datetime specified. \r
8287 Please provide a datetime format that can be parsed via \r
8288 <see cref="M:System.DateTime.Parse(System.String,System.IFormatProvider)"/>.\r
8289 </summary>\r
8290 <remarks>\r
8291 This property is ignored when <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel"/> set to \r
8292 <see langword="true"/>.\r
8293 </remarks>\r
8294 </member>\r
8295 <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel">\r
8296 <summary>\r
8297 Task for supporting labeling of repositories with incremented version \r
8298 numbers. The version number calculated will be concatenated to the \r
8299 <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label"/>.\r
8300 </summary>\r
8301 <remarks>\r
8302 <para>\r
8303 Instruments root of repository with <c>versionnumber.xml</c> file.\r
8304 </para>\r
8305 <para>\r
8306 If this file is not present, it is created and checked into StarTeam. \r
8307 The default version number is 1.0.0. By default the build number is \r
8308 incremented. Properties are present to allow setting and incrementing \r
8309 of major, minor, and build versions.\r
8310 </para>\r
8311 <para>\r
8312 When label is created, properties are set to expose version information \r
8313 and the new label :\r
8314 </para>\r
8315 <list type="bullet">\r
8316 <item>\r
8317 <description>label</description>\r
8318 </item>\r
8319 <item>\r
8320 <description>Version.text</description>\r
8321 </item>\r
8322 <item>\r
8323 <description>Version.major</description>\r
8324 </item>\r
8325 <item>\r
8326 <description>Version.minor</description>\r
8327 </item>\r
8328 <item>\r
8329 <description>Version.build</description>\r
8330 </item>\r
8331 </list>\r
8332 <note>\r
8333 Incrementing or setting major or minor versions does NOT reset the \r
8334 build version.\r
8335 </note>\r
8336 </remarks>\r
8337 <example>\r
8338 <para>Increment the build version.</para>\r
8339 <code>\r
8340 <![CDATA[\r
8341 <stautolabel url="${ST.url}" />\r
8342 ]]>\r
8343 </code>\r
8344 </example>\r
8345 <example>\r
8346 <para>Set the major version.</para>\r
8347 <code>\r
8348 <![CDATA[\r
8349 <stautolabel majorversion="2" url="${ST.url}" />\r
8350 ]]>\r
8351 </code>\r
8352 </example>\r
8353 <example>\r
8354 <para>Increment the minor version.</para>\r
8355 <code>\r
8356 <![CDATA[\r
8357 <stautolabel incrementminor="true" url="${ST.url}" />\r
8358 ]]>\r
8359 </code>\r
8360 </example>\r
8361 <example>\r
8362 <para>Example <c>versionnumber.xml</c> file.</para>\r
8363 <code>\r
8364 <![CDATA[\r
8365 <?xml version="1.0"?>\r
8366 <stautolabel>\r
8367 <version major="1" minor="0" build="0" />\r
8368 </stautolabel>\r
8369 ]]>\r
8370 </code>\r
8371 </example>\r
8372 </member>\r
8373 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.ExecuteTask">\r
8374 <summary>\r
8375 Looks for versionnumber.xml at root of repository. \r
8376 Updates the xml in this file to correspond with properties set by user and checks in changes. \r
8377 A label is then created based on properties set. \r
8378 </summary>\r
8379 <remarks>\r
8380 Default behavior is to <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild"/> number. \r
8381 If user sets <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion"/>, <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion"/>, or <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion"/> no incrementing is done \r
8382 and the exact version set and/or read from versionnumber.xml is used.\r
8383 <para>The title of the Label is the <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label"/> property concatenated with the version number Major.Minor.Build</para>\r
8384 </remarks>\r
8385 </member>\r
8386 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.getVersionStFile(StarTeam.StView)">\r
8387 <summary>\r
8388 Locate the <c>versionnumber.xml</c> file in the repository. If it \r
8389 is not present, the file is created. The file is checked out \r
8390 exclusively for editing.\r
8391 </summary>\r
8392 <param name="snapshot">StarTeam view we are working with.</param>\r
8393 <returns>\r
8394 StarTeam file handle containing version xml.\r
8395 </returns>\r
8396 </member>\r
8397 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.createVersionStFile(StarTeam.StFolder)">\r
8398 <summary>\r
8399 Creates the versionumber.xml file in the repository.\r
8400 </summary>\r
8401 <param name="stFolder">StarTeam folder desired to put the versionnumber.xml files into</param>\r
8402 <returns>StarTeam File handle to the created file.</returns>\r
8403 </member>\r
8404 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.VersionFile">\r
8405 <summary> \r
8406 Allows user to specify the filename where the version xml is stored. \r
8407 The default is <c>versionnumber.xml</c>.\r
8408 </summary>\r
8409 </member>\r
8410 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMajor">\r
8411 <summary> \r
8412 Increment major version number. The default is <see langword="false"/>.\r
8413 If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion"/> is set, this property is ignored.\r
8414 </summary>\r
8415 </member>\r
8416 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMinor">\r
8417 <summary> \r
8418 Increment minor version number. The default is <see langword="false"/>. \r
8419 If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion"/> is set, this property is ignored.\r
8420 </summary>\r
8421 </member>\r
8422 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild">\r
8423 <summary> \r
8424 Increment build version number. The default is <see langword="true"/>.\r
8425 If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion"/> is set, this property is ignored.\r
8426 </summary>\r
8427 </member>\r
8428 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion">\r
8429 <summary> \r
8430 Major version number used for label. If this value is set, \r
8431 <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMajor"/> is ignored.\r
8432 </summary>\r
8433 </member>\r
8434 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion">\r
8435 <summary> \r
8436 Minor version number used for label. If this value is set, \r
8437 <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMinor"/> is ignored.\r
8438 </summary>\r
8439 </member>\r
8440 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion">\r
8441 <summary> \r
8442 Build version number used for label. \r
8443 If this value is set. <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild"/> is ignored.\r
8444 </summary>\r
8445 </member>\r
8446 <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin">\r
8447 <summary>\r
8448 Task to check in files to StarTeam repositories. \r
8449 </summary>\r
8450 <remarks>\r
8451 <para>You add files to the repository that are not controlled by setting <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.adduncontrolled"/>.</para>\r
8452 <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stcheckin </para>\r
8453 <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>\r
8454 </remarks>\r
8455 <example>\r
8456 <para>Recursively checks in all files in the project.</para>\r
8457 <code>\r
8458 <![CDATA[\r
8459 <!-- \r
8460 constructs a 'url' containing connection information to pass to the task \r
8461 alternatively you can set each attribute manually \r
8462 -->\r
8463 <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />\r
8464 <stcheckin forced="true" rootstarteamfolder="/" recursive="true" url="${ST.url}" />\r
8465 ]]>\r
8466 </code>\r
8467 </example>\r
8468 </member>\r
8469 <member name="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask">\r
8470 <summary>\r
8471 Base for tree based star team tasks.\r
8472 </summary>\r
8473 <remarks>\r
8474 <para>\r
8475 Abstracts tree-walking behavior common to many subtasks.\r
8476 </para>\r
8477 <para>\r
8478 This class provides tree iteration functionality. Derived classes will implement their specific task \r
8479 functionally using the visitor pattern, specifically by implementing the method <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)"/>\r
8480 </para>\r
8481 <para>This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html </para>\r
8482 <para>You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.</para>\r
8483 </remarks>\r
8484 </member>\r
8485 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ExecuteTask">\r
8486 <summary>\r
8487 Does the work of opening the supplied Starteam view and calling \r
8488 the <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)"/> method setting the pattern in motion to perform the task.\r
8489 </summary>\r
8490 </member>\r
8491 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.getLabelID(StarTeam.StView)">\r
8492 <summary> \r
8493 Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label.\r
8494 </summary>\r
8495 <returns>The Label identifier or <c>-1</c> if no label was provided.</returns>\r
8496 </member>\r
8497 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)">\r
8498 <summary> Derived classes must override this class to define actual processing to be performed on each folder in the tree defined for the task</summary>\r
8499 <param name="rootStarteamFolder">the StarTeam folderto be visited</param>\r
8500 <param name="rootLocalFolder">the local mapping of rootStarteamFolder</param>\r
8501 </member>\r
8502 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.testPreconditions">\r
8503 <summary> \r
8504 Derived classes must override this method to define tests for any preconditons required by the task. \r
8505 This method is called at the beginning of the ExecuteTask method. \r
8506 </summary>\r
8507 <seealso cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ExecuteTask"/>\r
8508 </member>\r
8509 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.listLocalFiles(System.IO.FileInfo)">\r
8510 <summary> \r
8511 Gets the collection of the local file names in the supplied directory.\r
8512 We need to check this collection against what we find in Starteam to\r
8513 understand what we need to do in order to synch with the repository.\r
8514 </summary>\r
8515 <remarks>\r
8516 The goal is to keep track of which local files are not controlled by StarTeam.\r
8517 </remarks>\r
8518 <param name="localFolder">Local folder to scan</param>\r
8519 <returns>hashtable whose keys represent a file or directory in localFolder.</returns>\r
8520 </member>\r
8521 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.delistLocalFile(System.Collections.Hashtable,System.IO.FileInfo)">\r
8522 <summary> \r
8523 Removes file being worked with from the <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.listLocalFiles(System.IO.FileInfo)"/> generated hashtable.\r
8524 </summary>\r
8525 <remarks>\r
8526 The goal is to keep track of which local files are not controlled by StarTeam.\r
8527 </remarks>\r
8528 <param name="localFiles">Hashtable of the current directory's file|dire</param>\r
8529 <param name="thisfile">file to remove from list.</param>\r
8530 </member>\r
8531 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.IsIncluded(System.String)">\r
8532 <summary>\r
8533 Evaluates defined <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes"/> and <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Excludes"/> patterns against a filename. \r
8534 </summary>\r
8535 <param name="filePath"></param>\r
8536 <returns></returns>\r
8537 </member>\r
8538 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ToRegexPattern(System.String)">\r
8539 <summary>\r
8540 Lifted/Modified from <see cref="T:NAnt.Core.DirectoryScanner"/> to convert patterns to match filenames to regularexpressions.\r
8541 </summary>\r
8542 <param name="nantPattern">Search pattern - meant to be just a filename with no path info</param>\r
8543 <remarks>The directory seperation code in here most likely is overkill.</remarks>\r
8544 <returns>Regular expresssion for searching matching file names</returns>\r
8545 </member>\r
8546 <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.populatePatterns(System.Collections.Specialized.StringCollection,System.Collections.Specialized.StringCollection@)">\r
8547 <summary>\r
8548 Convert path patterns to regularexpression patterns. Stored in the given string collection.\r
8549 </summary>\r
8550 <param name="paths">collection of paths to expand into regular expressions</param>\r
8551 <param name="patterns">collection to store the given regularexpression patterns</param>\r
8552 </member>\r
8553 <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.rootstarteamfolder">\r
8554 <summary>\r
8555 Root StarTeam folder to begin operations on. Defaults to the root of the view.\r
8556 </summary>\r
8557 </member>\r
8558 <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.RootLocalFolder">\r
8559 <summary>\r
8560 Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder. \r
8561 </summary>\r
8562 </member>\r
8563 <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes">\r
8564 <summary>\r
8565 Accepts comma de-limited list of expressions to include in tree operations. \r
8566 If nothing is set ALL filespecs are included.\r
8567 </summary>\r
8568 <example>\r
8569 <para>Match all C# files in the directory</para>\r
8570 <code>*.cs</code>\r
8571 </example>\r
8572 <remarks>\r
8573 Expressions should be just for filename matching. \r
8574 Technically relative directory information is accepted but will never match.\r
8575 </remarks>\r
8576 </member>\r
8577 <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Excludes">\r
8578 <summary>\r
8579 Accepts comma de-limited list of expressions to exclude from tree operations. \r
8580 If nothing is specified. NO filespecs are excluded.\r
8581 </summary>\r
8582 <example>\r
8583 <para>Match <b>No</b> C# files in the directory</para>\r
8584 <code>*.cs</code>\r
8585 </example>\r
8586 <remarks>\r
8587 <para>\r
8588 If a excludes pattern is set with no <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes"/> patterns present includes defaults to "*"\r
8589 </para>\r
8590 Expressions should be just for filename matching. \r
8591 Technically relative directory information is accepted but will never match.\r
8592 </remarks>\r
8593 </member>\r
8594 <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.recursive">\r
8595 <summary>\r
8596 Default : true - should tasks recurse through tree.\r
8597 </summary>\r
8598 </member>\r
8599 <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Forced">\r
8600 <summary>\r
8601 Default : false - force check in/out actions regardless of the status that StarTeam is maintaining for the file. \r
8602 </summary>\r
8603 <remarks>\r
8604 <para>If <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.RootLocalFolder"/> is set then this property should be set <c>true</c>. \r
8605 Otherwise the checkout will be based on how the repository compares to local target folder.\r
8606 </para>\r
8607 <para>Note that if forced is not on. Files with status Modified and Merge will not be processed.</para>\r
8608 </remarks>\r
8609 </member>\r
8610 <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label">\r
8611 <summary> \r
8612 Label used for checkout. If no label is set latest state of repository is checked out.\r
8613 </summary>\r
8614 <remarks>\r
8615 The label must exist in starteam or an exception will be thrown. \r
8616 </remarks>\r
8617 </member>\r
8618 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.starTeamLockTypeStatics">\r
8619 <summary>classes used to access static values</summary>\r
8620 </member>\r
8621 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.starteamFolderFactory">\r
8622 <summary>Facotry classes used when files and folders are added to the repository. Populated when adduncontrolled is enabled.</summary>\r
8623 </member>\r
8624 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._createFolders">\r
8625 <value> will folders be created for new items found with the checkin.</value>\r
8626 </member>\r
8627 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._comment">\r
8628 <value> The comment which will be stored with the checkin.</value>\r
8629 </member>\r
8630 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._addUncontrolled">\r
8631 <value> holder for the add Uncontrolled attribute. If true, all local files not in StarTeam will be added to the repository.</value>\r
8632 </member>\r
8633 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._lockStatus">\r
8634 <value> This attribute tells whether unlocked files on checkin (so that other users may access them) checkout or to \r
8635 leave the checkout status alone (default).\r
8636 </value>\r
8637 </member>\r
8638 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.createSnapshotView(StarTeam.StView)">\r
8639 <summary>\r
8640 Override of base-class abstract function creates an appropriately configured view. For checkins this is\r
8641 always the current or "tip" view.\r
8642 </summary>\r
8643 <param name="raw">the unconfigured <code>View</code></param>\r
8644 <returns>the snapshot <code>View</code> appropriately configured.</returns>\r
8645 </member>\r
8646 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.testPreconditions">\r
8647 <summary> Implements base-class abstract function to define tests for any preconditons required by the task</summary>\r
8648 </member>\r
8649 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.visit(StarTeam.StFolder,System.IO.FileInfo)">\r
8650 <summary> Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree.</summary>\r
8651 <param name="starteamFolder">the StarTeam folder to which files will be checked in</param>\r
8652 <param name="targetFolder">local folder from which files will be checked in</param>\r
8653 </member>\r
8654 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.addUncontrolledItems(System.Collections.Hashtable,StarTeam.StFolder)">\r
8655 <summary> Adds to the StarTeam repository everything on the local machine that is not currently in the repository.</summary>\r
8656 <param name="localFiles">Hasttable containing files missing in the repository for the current folder</param>\r
8657 <param name="folder">StarTeam folder to which these items are to be added.</param>\r
8658 </member>\r
8659 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.add(StarTeam.StFolder,System.IO.FileInfo)">\r
8660 <summary> Adds the file or directpry to the repository.</summary>\r
8661 <param name="parentFolder">StarTeam folder underwhich items will be added.</param>\r
8662 <param name="file">the file or directory to add</param>\r
8663 <returns>true if the file was successfully added otherwise false.</returns>\r
8664 </member>\r
8665 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.adduncontrolled">\r
8666 <summary> \r
8667 if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false".\r
8668 </summary>\r
8669 </member>\r
8670 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.unlocked">\r
8671 <summary> \r
8672 Set to do an unlocked checkout; optional, default is false; \r
8673 If true, file will be unlocked so that other users may change it. If false, lock status will not change. \r
8674 </summary>\r
8675 </member>\r
8676 <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout">\r
8677 <summary>\r
8678 Task to check out files from StarTeam repositories. \r
8679 </summary>\r
8680 <remarks>\r
8681 <para>You can check out by <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label"/> and control the type of lock with <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.locktype"/>.</para>\r
8682 <para>You can delete files that are not in source control by setting <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteuncontrolled"/>.</para>\r
8683 <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stcheckout </para>\r
8684 <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>\r
8685 </remarks>\r
8686 <example>\r
8687 <para>Recursively checks out all files in the project with an exclusive lock.</para>\r
8688 <code>\r
8689 <![CDATA[\r
8690 <!-- \r
8691 constructs a 'url' containing connection information to pass to the task \r
8692 alternatively you can set each attribute manually \r
8693 -->\r
8694 <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />\r
8695 <stcheckout locktype="exclusive" rootstarteamfolder="/" recursive="true" url="${ST.url}" />\r
8696 ]]>\r
8697 </code>\r
8698 </example>\r
8699 </member>\r
8700 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._createDirs">\r
8701 <value> holder for the createDirs property.</value>\r
8702 </member>\r
8703 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._deleteUncontrolled">\r
8704 <value> holder for the deleteUncontrolled property.</value>\r
8705 </member>\r
8706 <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._lockStatus">\r
8707 <value> holder for the lockstatus property. </value>\r
8708 </member>\r
8709 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.createSnapshotView(StarTeam.StView)">\r
8710 <summary> \r
8711 Override of base-class abstract function creates an appropriately configured view for checkout. \r
8712 If a label is specified it is used otherwise the current view of the repository is used.\r
8713 </summary>\r
8714 <param name="raw">the unconfigured <code>StarTeam View</code></param>\r
8715 <returns>the snapshot <code>StarTeam View</code> appropriately configured.</returns>\r
8716 </member>\r
8717 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.testPreconditions">\r
8718 <summary> Implements base-class abstract function to define tests for any preconditons required by the task</summary>\r
8719 </member>\r
8720 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.visit(StarTeam.StFolder,System.IO.FileInfo)">\r
8721 <summary> \r
8722 Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree.\r
8723 </summary>\r
8724 <param name="starteamFolder">the StarTeam folder from which files to be checked out</param>\r
8725 <param name="targetFolder">the local mapping of the starteam folder</param>\r
8726 </member>\r
8727 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteUncontrolledItems(System.Collections.Hashtable)">\r
8728 <summary> \r
8729 Deletes everything on the local machine that is not in the repository.\r
8730 </summary>\r
8731 <param name="localFiles">Hashtable containing filenames to be deleted</param>\r
8732 </member>\r
8733 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.delete(System.IO.FileInfo)">\r
8734 <summary> Utility method to delete the file (and it's children) from the local drive.</summary>\r
8735 <param name="file">the file or directory to delete.</param>\r
8736 <returns>was the file successfully deleted</returns>\r
8737 </member>\r
8738 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.createworkingdirs">\r
8739 <summary> \r
8740 Default : true - Create directories that are in the Starteam repository even if they are empty.\r
8741 </summary>\r
8742 </member>\r
8743 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteuncontrolled">\r
8744 <summary> \r
8745 <b>Not fully tested CAREFUL</b> Default : false - Should all local files <b>NOT</b> in StarTeam be deleted?\r
8746 </summary>\r
8747 </member>\r
8748 <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.locktype">\r
8749 <summary> \r
8750 What type of lock to apply to files checked out.\r
8751 <list type="bullet">\r
8752 <listheader>\r
8753 <term>LockType</term>\r
8754 </listheader>\r
8755 <item>\r
8756 <term>unchanged</term>\r
8757 <description>default: do not make any changes to the lock state of items.</description>\r
8758 </item>\r
8759 <item>\r
8760 <term>exclusive</term>\r
8761 <description>Exclusively lock items. No other users can update the object while it is exclusively locked.</description>\r
8762 </item>\r
8763 <item>\r
8764 <term>nonexclusive</term>\r
8765 <description>Put a non-exclusive lock on the item.</description>\r
8766 </item>\r
8767 <item>\r
8768 <term>unlocked</term>\r
8769 <description>Remove locks from all items checked out. This accompanied by force would effectively override a lock and replace local contents with the current version.</description>\r
8770 </item>\r
8771 </list>\r
8772 </summary>\r
8773 </member>\r
8774 <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamLabel">\r
8775 <summary>\r
8776 Allows creation of view labels in StarTeam repositories.\r
8777 </summary>\r
8778 <remarks>\r
8779 <para>Often when building projects you wish to label the source control repository.</para>\r
8780 <para>By default this task creates view labels with the build option turned on.</para>\r
8781 <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel </para>\r
8782 <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>\r
8783 </remarks>\r
8784 <example>\r
8785 <para>Creates a label in a StarTeam repository.</para>\r
8786 <code>\r
8787 <![CDATA[\r
8788 <!-- \r
8789 constructs a 'url' containing connection information to pass to the task \r
8790 alternatively you can set each attribute manually \r
8791 -->\r
8792 <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />\r
8793 <stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />\r
8794 ]]>\r
8795 </code>\r
8796 </example>\r
8797 </member>\r
8798 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamLabel.ExecuteTask">\r
8799 <summary>\r
8800 This method does the work of creating the new view and checking it \r
8801 into Starteam.\r
8802 </summary>\r
8803 </member>\r
8804 <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamList">\r
8805 <summary>\r
8806 List items in StarTeam repositories.\r
8807 </summary>\r
8808 <remarks>\r
8809 <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlist </para>\r
8810 <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>\r
8811 </remarks>\r
8812 <example>\r
8813 <para>Lists all files in a StarTeam repository.</para>\r
8814 <code>\r
8815 <![CDATA[\r
8816 <!-- \r
8817 constructs a 'url' containing connection information to pass to the task \r
8818 alternatively you can set each attribute manually \r
8819 -->\r
8820 <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />\r
8821 <stlist rootstarteamfolder="/" recursive="true" url="${ST.url}" />\r
8822 ]]>\r
8823 </code>\r
8824 </example>\r
8825 </member>\r
8826 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.createSnapshotView(StarTeam.StView)">\r
8827 <summary>\r
8828 Override of base-class abstract function creates an appropriately configured view for checkoutlists. \r
8829 The current view or a view of the label specified <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label"/>.\r
8830 </summary>\r
8831 <param name="raw">the unconfigured <c>View</c></param>\r
8832 <returns>the snapshot <c>View</c> appropriately configured.</returns>\r
8833 </member>\r
8834 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.testPreconditions">\r
8835 <summary>Required base-class abstract function implementation is a no-op here.</summary>\r
8836 </member>\r
8837 <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.visit(StarTeam.StFolder,System.IO.FileInfo)">\r
8838 <summary> Implements base-class abstract function to perform the checkout\r
8839 operation on the files in each folder of the tree.</summary>\r
8840 <param name="starteamFolder">the StarTeam folder from which files to be checked out</param>\r
8841 <param name="targetFolder">the local mapping of rootStarteamFolder</param>\r
8842 </member>\r
8843 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch">\r
8844 <summary>\r
8845 Processes <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see> batch files.\r
8846 </summary>\r
8847 <remarks>\r
8848 Processes the batch commands found in the input file. Each line in the \r
8849 input file should contain a single Surround SCM command including proper \r
8850 command line options. The sscm command, Surround SCM server address, \r
8851 port number, username and password are not required for each command line.\r
8852 </remarks>\r
8853 <example>\r
8854 <para>\r
8855 Run the batch file <c>${src}/sscm.batch</c> on the server at localhost,\r
8856 port 4900 with username 'administrator' and a blank password. All script\r
8857 output is directed to the console.\r
8858 </para>\r
8859 <code>\r
8860 <sscmbatch\r
8861 serverconnect="localhost:4900"\r
8862 serverlogin="administrator:"\r
8863 input="${src}/sscm.batch"\r
8864 />\r
8865 </code>\r
8866 </example>\r
8867 <example>\r
8868 <para>\r
8869 Run the batch file <c>${src}/sscm.batch</c> on the server at localhost, \r
8870 port 4900 with username 'administrator' and a blank password. All script \r
8871 output is redirected to <c>${dist}/sscm.batch.out</c>.\r
8872 </para>\r
8873 <code>\r
8874 <sscmbatch\r
8875 serverconnect="localhost:4900"\r
8876 serverconnect="administrator:"\r
8877 input="${src}/sscm.batch"\r
8878 output="${dist}/sscm.batch.out"\r
8879 />\r
8880 </code>\r
8881 </example>\r
8882 </member>\r
8883 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask">\r
8884 <summary>\r
8885 <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>\r
8886 abstract task base.\r
8887 </summary>\r
8888 </member>\r
8889 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.WriteCommandLineArguments(System.Text.StringBuilder)">\r
8890 <summary>\r
8891 Writes the task-specific arguments to the specified \r
8892 <see cref="T:System.Text.StringBuilder"/>.\r
8893 </summary>\r
8894 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
8895 </member>\r
8896 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ServerConnect">\r
8897 <summary>\r
8898 The address and port number of the Surround SCM server host computer. \r
8899 Format is server:port. If not entered, the last saved connection \r
8900 parameters are used.\r
8901 </summary>\r
8902 </member>\r
8903 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ServerLogin">\r
8904 <summary>\r
8905 The username and password used to login to the Surround SCM server. \r
8906 Format is username:password. If not entered, the last saved login \r
8907 parameters are used.\r
8908 </summary>\r
8909 </member>\r
8910 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ExeName">\r
8911 <summary>\r
8912 Override ExeName paramater to sscm.exe for Surround SCM.\r
8913 </summary>\r
8914 </member>\r
8915 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ProgramArguments">\r
8916 <summary>\r
8917 Gets the command line arguments for the external program.\r
8918 </summary>\r
8919 <value>\r
8920 The command line arguments for the external program.\r
8921 </value>\r
8922 </member>\r
8923 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.WriteCommandLineArguments(System.Text.StringBuilder)">\r
8924 <summary>\r
8925 Writes the task-specific arguments to the specified \r
8926 <see cref="T:System.Text.StringBuilder"/>.\r
8927 </summary>\r
8928 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
8929 </member>\r
8930 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.InputFile">\r
8931 <summary>\r
8932 File to read commands from.\r
8933 </summary>\r
8934 </member>\r
8935 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.OutputFile">\r
8936 <summary>\r
8937 File to direct all standard output to. When executing commands from \r
8938 the input file, all output is written to this file instead of being \r
8939 displayed on the screen.\r
8940 </summary>\r
8941 </member>\r
8942 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch">\r
8943 <summary>\r
8944 Creates new branches for <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>.\r
8945 </summary>\r
8946 <example>\r
8947 <para>\r
8948 Create a new Baseline branch 'Widget 1.0' from branch 'Mainline', \r
8949 repository 'Mainline/Widget' with the given comments. All files \r
8950 are branched at the tip version.\r
8951 </para>\r
8952 <code>\r
8953 <sscmbranch\r
8954 serverconnect="localhost:4900"\r
8955 serverlogin="administrator:"\r
8956 branch="Widget 1.0"\r
8957 repository="Mainline/Widget"\r
8958 parent="Mainline"\r
8959 comment="Branch for continuing Widget 1.0 development"\r
8960 type="baseline"\r
8961 />\r
8962 </code>\r
8963 </example>\r
8964 <example>\r
8965 <para>\r
8966 Create a new Workspace branch 'MyWidgetDevelopment' from branch \r
8967 'Widget 1.0', repository 'Mainline/Widget'. All files are branched \r
8968 at the tip version.\r
8969 </para>\r
8970 <code>\r
8971 <sscmbranch\r
8972 serverconnect="localhost:4900"\r
8973 serverlogin="administrator:"\r
8974 branch="MyWidgetDevelopment"\r
8975 repository="Mainline/Widget"\r
8976 parent="Widget 1.0"\r
8977 />\r
8978 </code>\r
8979 </example>\r
8980 <example>\r
8981 <para>\r
8982 Create a new Snapshot branch 'Build as of 12-1-03' from branch \r
8983 'Widget 1.0', repository 'Mainline/Widget' with the given comments. \r
8984 All files are branched at their version as of 12-01-03.\r
8985 </para>\r
8986 <code>\r
8987 <sscmbranch\r
8988 serverconnect="localhost:4900"\r
8989 serverlogin="administrator:"\r
8990 name="Build as of 12-1-03"\r
8991 repository="Mainline/Widget"\r
8992 branch="Widget 1.0"\r
8993 comment="Snapshot of source as it was on December 1st, 2003"\r
8994 timestamp="2003120300:00:00"\r
8995 type="snapshot"\r
8996 />\r
8997 </code>\r
8998 </example>\r
8999 </member>\r
9000 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.WriteCommandLineArguments(System.Text.StringBuilder)">\r
9001 <summary>\r
9002 Writes the task-specific arguments to the specified \r
9003 <see cref="T:System.Text.StringBuilder"/>.\r
9004 </summary>\r
9005 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
9006 </member>\r
9007 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Branch">\r
9008 <summary>\r
9009 The name of the branch you want to create.\r
9010 </summary>\r
9011 </member>\r
9012 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Repository">\r
9013 <summary>\r
9014 The full repository path.\r
9015 </summary>\r
9016 </member>\r
9017 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ParentBranch">\r
9018 <summary>\r
9019 The parent branch you want to create the new, child branch from. \r
9020 If not specified, the mainline branch is used.\r
9021 </summary>\r
9022 </member>\r
9023 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Comment">\r
9024 <summary>\r
9025 Specifies a comment for the branch operation.\r
9026 </summary>\r
9027 </member>\r
9028 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel">\r
9029 <summary>\r
9030 Specifies which parent branch file versions are copied into the \r
9031 child branch.\r
9032 </summary>\r
9033 </member>\r
9034 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByTimestamp">\r
9035 <summary>\r
9036 Specifies which parent branch file versions are copied into the \r
9037 child branch. Format is yyyymmddhh:mm:ss. If <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel"/>\r
9038 attribute is specified, this parameter is ignored.\r
9039 </summary>\r
9040 </member>\r
9041 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.IncludeRemoved">\r
9042 <summary>\r
9043 Include removed files when creating a branch with the \r
9044 <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel"/> or <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByTimestamp"/> option. \r
9045 The default is <see langword="true"/>.\r
9046 </summary>\r
9047 </member>\r
9048 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Type">\r
9049 <summary>\r
9050 Specifies the type of branch you want to create. Possible values are\r
9051 <c>workspace</c>, <c>baseline</c>, or <c>snapshot</c>. The default is \r
9052 <c>workspace</c>.\r
9053 </summary>\r
9054 </member>\r
9055 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin">\r
9056 <summary>\r
9057 Checks in files in <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>\r
9058 repository.\r
9059 </summary>\r
9060 <remarks>\r
9061 Check in updated Surround SCM files with changes, removes the lock on \r
9062 the files, and makes changes available to other users.\r
9063 </remarks>\r
9064 <example>\r
9065 <para>\r
9066 Check In all files and repositories from repository 'Mainline/Widget' \r
9067 recursively from the 'Widget 1.0' branch to the working directory setup \r
9068 for user 'administrator'. This call outputs the progress of the Check In \r
9069 to the console.\r
9070 </para>\r
9071 <code>\r
9072 <sscmcheckin\r
9073 serverconnect="localhost:4900"\r
9074 serverlogin="administrator:"\r
9075 file="/"\r
9076 branch="Widget 1.0"\r
9077 repository="Mainline/Widget"\r
9078 recursive="true"\r
9079 comment="I made some changes"\r
9080 />\r
9081 </code>\r
9082 </example>\r
9083 <example>\r
9084 <para>\r
9085 Check in file 'Mainline/Widget/Widget.java' from the 'Widget 1.0' \r
9086 branch from the working directory setup for user 'administrator' \r
9087 with comment 'I made some changes'. Set the 'Release 1.1.1' label \r
9088 to this new version, even if the label already exists on an earlier \r
9089 version.\r
9090 </para>\r
9091 <code>\r
9092 <sscmcheckin\r
9093 serverconnect="localhost:4900"\r
9094 serverlogin="administrator:"\r
9095 file="Widget.java"\r
9096 branch="Widget 1.0"\r
9097 repository="Mainline/Widget"\r
9098 comment="I made some changes"\r
9099 label="Release 1.1.1"\r
9100 overwritelabel="true"\r
9101 />\r
9102 </code>\r
9103 </example>\r
9104 </member>\r
9105 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.WriteCommandLineArguments(System.Text.StringBuilder)">\r
9106 <summary>\r
9107 Writes the task-specific arguments to the specified \r
9108 <see cref="T:System.Text.StringBuilder"/>.\r
9109 </summary>\r
9110 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
9111 </member>\r
9112 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Branch">\r
9113 <summary>\r
9114 Surround SCM branch name. The default is pulled from the local \r
9115 working directory.\r
9116 </summary>\r
9117 </member>\r
9118 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Repository">\r
9119 <summary>\r
9120 Surround SCM repository path. The default is pulled from the local \r
9121 working directory.\r
9122 </summary>\r
9123 </member>\r
9124 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.File">\r
9125 <summary>\r
9126 File or repository name. Can be / or empty, which means the \r
9127 repository specified by the repository option or the default \r
9128 repository.\r
9129 </summary>\r
9130 </member>\r
9131 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Comment">\r
9132 <summary>\r
9133 Comment for the check-in.\r
9134 </summary>\r
9135 </member>\r
9136 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.SkipAutomerge">\r
9137 <summary>\r
9138 Force check in without merge. Ignores code changes checked in after \r
9139 the user's last checkout or merge. The default is <see langword="false" />.\r
9140 </summary>\r
9141 </member>\r
9142 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.GetLocal">\r
9143 <summary>\r
9144 Get file after check in. The default is <see langword="true" />.\r
9145 </summary>\r
9146 </member>\r
9147 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.KeepLocked">\r
9148 <summary>\r
9149 Keep the lock after check in. The default is <see langword="false" />.\r
9150 </summary>\r
9151 </member>\r
9152 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Label">\r
9153 <summary>\r
9154 A label for the check in code.\r
9155 </summary>\r
9156 </member>\r
9157 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.OverwriteLabel">\r
9158 <summary>\r
9159 Overwrite previous label on file. The default is \r
9160 <see langword="false" />.\r
9161 </summary>\r
9162 </member>\r
9163 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Quiet">\r
9164 <summary>\r
9165 Do not list repository and local full path of the Surround \r
9166 SCM server. The default is <see langword="false" />.\r
9167 </summary>\r
9168 </member>\r
9169 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Recursive">\r
9170 <summary>\r
9171 Recursively check in all files and sub-repositories.\r
9172 The default is <see langword="false" />.\r
9173 </summary>\r
9174 </member>\r
9175 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpDatabase">\r
9176 <summary>\r
9177 The TestTrack Pro database configuration name.\r
9178 </summary>\r
9179 </member>\r
9180 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpLogin">\r
9181 <summary>\r
9182 The TestTrack Pro username and password.\r
9183 </summary>\r
9184 </member>\r
9185 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpDefects">\r
9186 <summary>\r
9187 The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#".\r
9188 </summary>\r
9189 </member>\r
9190 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Writable">\r
9191 <summary>\r
9192 Make file writable after check in. The default is \r
9193 <see langword="false" />.\r
9194 </summary>\r
9195 </member>\r
9196 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.ForceUpdate">\r
9197 <summary>\r
9198 Update version even if no changes. The default is \r
9199 <see langword="false" />.\r
9200 </summary>\r
9201 </member>\r
9202 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.DeleteLocal">\r
9203 <summary>\r
9204 Remove local file after check in. The default is \r
9205 <see langword="false" />.\r
9206 </summary>\r
9207 </member>\r
9208 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout">\r
9209 <summary>\r
9210 Checks out files from a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>\r
9211 repository.\r
9212 </summary>\r
9213 <remarks>\r
9214 You can check out single files, multiple files, or a full repository. \r
9215 Surround SCM creates a read-write copy of the files in the working \r
9216 directory.\r
9217 </remarks>\r
9218 <example>\r
9219 <para>\r
9220 Check Out all files and repositories from repository 'Mainline/Widget' \r
9221 recursively from the 'Widget 1.0' branch to the working directory setup \r
9222 for user 'administrator'. This call forces the file retrieval from the \r
9223 server even if the local file is current and overwrites any writable\r
9224 local files with the server copy.\r
9225 </para>\r
9226 <code>\r
9227 <sscmcheckout\r
9228 serverconnect="localhost:4900"\r
9229 serverlogin="administrator:"\r
9230 file="/"\r
9231 branch="Widget 1.0"\r
9232 repository="Mainline/Widget"\r
9233 recursive="true"\r
9234 force="true"\r
9235 comment="This is my Check Out comment"\r
9236 />\r
9237 </code>\r
9238 </example>\r
9239 <example>\r
9240 <para>\r
9241 Check Out version 1 of the file 'Mainline/Widget/Widget.java' exclusively \r
9242 from the 'Widget 1.0' branch to the working directory setup for user \r
9243 'administrator'. Writable local files are not overwritten, even if they \r
9244 are out of date.\r
9245 </para>\r
9246 <code>\r
9247 <sscmcheckout\r
9248 serverconnect="localhost:4900"\r
9249 serverlogin="administrator:"\r
9250 quiet="true"\r
9251 file="Widget.java"\r
9252 branch="Widget 1.0"\r
9253 repository="Mainline/Widget"\r
9254 overwrite="false"\r
9255 writable="true"\r
9256 version="1"\r
9257 exclusive="true"\r
9258 />\r
9259 </code>\r
9260 </example>\r
9261 </member>\r
9262 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.WriteCommandLineArguments(System.Text.StringBuilder)">\r
9263 <summary>\r
9264 Writes the task-specific arguments to the specified \r
9265 <see cref="T:System.Text.StringBuilder"/>.\r
9266 </summary>\r
9267 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
9268 </member>\r
9269 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Branch">\r
9270 <summary>\r
9271 Surround SCM branch name. The default is pulled from the local \r
9272 working directory.\r
9273 </summary>\r
9274 </member>\r
9275 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Repository">\r
9276 <summary>\r
9277 Surround SCM repository path. The default is pulled from the local \r
9278 working directory.\r
9279 </summary>\r
9280 </member>\r
9281 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.File">\r
9282 <summary>\r
9283 File or repository name. Can be / or empty, which means the \r
9284 repository specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Repository"/> attribute\r
9285 or the default repository.\r
9286 </summary>\r
9287 </member>\r
9288 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Comment">\r
9289 <summary>\r
9290 Comment for the check-out.\r
9291 </summary>\r
9292 </member>\r
9293 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Force">\r
9294 <summary>\r
9295 Force file retrieval from server regardless of the local copy status.\r
9296 The default is <see langword="false" />.\r
9297 </summary>\r
9298 </member>\r
9299 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Quiet">\r
9300 <summary>\r
9301 Do not list repository and local full path of the Surround SCM server.\r
9302 The default is <see langword="false" />.\r
9303 </summary>\r
9304 </member>\r
9305 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Recursive">\r
9306 <summary>\r
9307 Recursively get files and sub-repositories. The default is \r
9308 <see langword="false" />.\r
9309 </summary>\r
9310 </member>\r
9311 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Overwrite">\r
9312 <summary>\r
9313 Specifies whether to overwrite local writable files. The default is\r
9314 <see langword="false" />.\r
9315 </summary>\r
9316 </member>\r
9317 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Timestamp">\r
9318 <summary>\r
9319 Specifies how to set the local file's date/time. Possible values are\r
9320 <c>current</c>, <c>modify</c> or <c>checkin</c>.\r
9321 </summary>\r
9322 </member>\r
9323 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Exclusive">\r
9324 <summary>\r
9325 Exclusively lock the files. The default is <see langword="false" />.\r
9326 </summary>\r
9327 </member>\r
9328 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Version">\r
9329 <summary>\r
9330 Specifies the file version to check out. Ignored if no specific \r
9331 filename is set using the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.File"/> attribute.\r
9332 </summary>\r
9333 </member>\r
9334 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze">\r
9335 <summary>\r
9336 Freezes branches in a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>\r
9337 repository.\r
9338 </summary>\r
9339 <remarks>\r
9340 Freezing a branch prevents any code changes being made to files in the \r
9341 branch. When a branch is frozen, it is locked and no changes can be \r
9342 made to it.\r
9343 </remarks>\r
9344 <example>\r
9345 <para>\r
9346 Freeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the \r
9347 server at localhost, port 4900 with username 'administrator' and a \r
9348 blank password. \r
9349 </para>\r
9350 <code>\r
9351 <sscmfreeze\r
9352 serverconnect="localhost:4900"\r
9353 serverlogin="administrator:"\r
9354 mainline="Mainline"\r
9355 branch="Widget 1.0"\r
9356 />\r
9357 </code>\r
9358 </example>\r
9359 </member>\r
9360 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.WriteCommandLineArguments(System.Text.StringBuilder)">\r
9361 <summary>\r
9362 Writes the task-specific arguments to the specified \r
9363 <see cref="T:System.Text.StringBuilder"/>.\r
9364 </summary>\r
9365 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
9366 </member>\r
9367 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.Branch">\r
9368 <summary>\r
9369 Surround SCM branch name.\r
9370 </summary>\r
9371 </member>\r
9372 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.Mainline">\r
9373 <summary>\r
9374 Surround SCM mainline branch name. The default is pulled from the \r
9375 local working directory.\r
9376 </summary>\r
9377 </member>\r
9378 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet">\r
9379 <summary>\r
9380 Gets files from a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>\r
9381 repository.\r
9382 </summary>\r
9383 <remarks>\r
9384 You can get a single file, multiple files, or a repository. A read-only \r
9385 copy of the file is created in the specified directory.\r
9386 </remarks>\r
9387 <example>\r
9388 <para>\r
9389 Get all files and repositories from repository 'Mainline/Widget' \r
9390 recursively from the 'Widget 1.0' branch to the working directory \r
9391 setup for user 'administrator'. This call forces the file retrieval \r
9392 from the server even if the local file is current and overwrites any \r
9393 local files that are writable with the server copy.\r
9394 </para>\r
9395 <code>\r
9396 <sscmget\r
9397 serverconnect="localhost:4900"\r
9398 serverlogin="administrator:"\r
9399 file="/"\r
9400 branch="Widget 1.0"\r
9401 repository="Mainline/Widget"\r
9402 recursive="true"\r
9403 force="true"\r
9404 overwrite="true"\r
9405 />\r
9406 </code>\r
9407 </example>\r
9408 <example>\r
9409 <para>\r
9410 Get version 1 of the file 'Mainline/Widget/Widget.java' from the \r
9411 'Widget 1.0' branch to the working directory setup for user 'administrator'.\r
9412 Writable local files are not overwritten, even if they are out of date.\r
9413 </para>\r
9414 <code>\r
9415 <sscmget\r
9416 serverconnect="localhost:4900"\r
9417 serverlogin="administrator:"\r
9418 quiet="true"\r
9419 file="Widget.java"\r
9420 branch="Widget 1.0"\r
9421 repository="Mainline/Widget"\r
9422 overwrite="false"\r
9423 writable="true"\r
9424 version="1"\r
9425 />\r
9426 </code>\r
9427 </example>\r
9428 <example>\r
9429 <para>\r
9430 Get all files and repositories labeled with 'Release 1.0.0' (even those \r
9431 removed from Surround) from repository 'Mainline/Widget' recursively \r
9432 from the 'Widget 1.0' branch to the '${build}/src' directory. Writable \r
9433 local files are overwritten with the server copy.\r
9434 </para>\r
9435 <code>\r
9436 <sscmget\r
9437 serverconnect="localhost:4900"\r
9438 serverlogin="administrator:"\r
9439 quiet="true"\r
9440 file="/"\r
9441 branch="Widget 1.0"\r
9442 repository="Mainline/Widget"\r
9443 recursive="true"\r
9444 label="Release 1.0.1"\r
9445 destdir="${build}/src"\r
9446 overwrite="true"\r
9447 />\r
9448 </code>\r
9449 </example>\r
9450 </member>\r
9451 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.WriteCommandLineArguments(System.Text.StringBuilder)">\r
9452 <summary>\r
9453 Writes the task-specific arguments to the specified \r
9454 <see cref="T:System.Text.StringBuilder"/>.\r
9455 </summary>\r
9456 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
9457 </member>\r
9458 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Branch">\r
9459 <summary>\r
9460 Surround SCM branch name. The default is pulled from the local \r
9461 working directory.\r
9462 </summary>\r
9463 </member>\r
9464 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Repository">\r
9465 <summary>\r
9466 Surround SCM repository path. The default is pulled from the local \r
9467 working directory.\r
9468 </summary>\r
9469 </member>\r
9470 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File">\r
9471 <summary>\r
9472 File or repository name. Can be / or empty, which means the repository \r
9473 specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Repository"/> attribute or the default \r
9474 repository.\r
9475 </summary>\r
9476 </member>\r
9477 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.DestinationDirectory">\r
9478 <summary>\r
9479 The local directory you want to get the files to. If \r
9480 <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> is a repository, a subrepository with the same \r
9481 name as the repository is created and files are copied to it. If \r
9482 <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> is specified as / or not set, files are copied to \r
9483 the local directory. If not specified, files are copied to the \r
9484 working directory.\r
9485 </summary>\r
9486 </member>\r
9487 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Writable">\r
9488 <summary>\r
9489 Make local file editable or writable. The default is \r
9490 <see langword="false" />.\r
9491 </summary>\r
9492 </member>\r
9493 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Force">\r
9494 <summary>\r
9495 Force file retrieval from server regardless of the local copy status.\r
9496 The default is <see langword="false" />.\r
9497 </summary>\r
9498 </member>\r
9499 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByLabel">\r
9500 <summary>\r
9501 Label to search for when getting a file. If a file version is \r
9502 specified, this parameter is ignored.\r
9503 </summary>\r
9504 </member>\r
9505 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByTimestamp">\r
9506 <summary>\r
9507 Timestamp to use when getting files. Format is yyyymmddhh:mm:ss. \r
9508 If <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByLabel"/> is specified, this parameter is ignored. \r
9509 Requires Surround SCM 3.0 or later.\r
9510 </summary>\r
9511 </member>\r
9512 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.IncludeRemoved">\r
9513 <summary>\r
9514 Include removed files when getting files by label or timestamp. \r
9515 The default is <see langword="true" />. Ignored if a label or \r
9516 timestamp is not specified.\r
9517 </summary>\r
9518 </member>\r
9519 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Quiet">\r
9520 <summary>\r
9521 Do not list repository and local full path of files. The default is \r
9522 <see langword="false" />.\r
9523 </summary>\r
9524 </member>\r
9525 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Recursive">\r
9526 <summary>\r
9527 Recursively get files and sub-repositories. The default is \r
9528 <see langword="false" />.\r
9529 </summary>\r
9530 </member>\r
9531 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Overwrite">\r
9532 <summary>\r
9533 Specifies whether to overwrite local writable files. The default is\r
9534 <see langword="false" />.\r
9535 </summary>\r
9536 </member>\r
9537 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Timestamp">\r
9538 <summary>\r
9539 Specifies how to set the local file's date/time. Possible values are\r
9540 <c>current</c>, <c>modify</c> or <c>checkin</c>.\r
9541 </summary>\r
9542 </member>\r
9543 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Version">\r
9544 <summary>\r
9545 The file version to get. Ignored if a filename is not specified in \r
9546 the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> attribute.\r
9547 </summary>\r
9548 </member>\r
9549 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel">\r
9550 <summary>\r
9551 Creates file or repository labels for a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>\r
9552 repository.\r
9553 </summary>\r
9554 <remarks>\r
9555 Labels provide a way to mark a specific version of a file or repository. \r
9556 You can create labels for single files, multiple files, or all files in \r
9557 a repository. When you create a label, a new entry is created in the history.\r
9558 The file, and the version number, do not change. Existing 'Release 1.0.1' \r
9559 labels on a file will be moved to the tip version of the file.\r
9560 </remarks>\r
9561 <example>\r
9562 <para>\r
9563 Label all files under the 'Mainline/Widget' repository recursively in \r
9564 the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment.\r
9565 </para>\r
9566 <code>\r
9567 <sscmlabel\r
9568 serverconnect="localhost:4900"\r
9569 serverlogin="administrator:"\r
9570 branch="Widget 1.0"\r
9571 repository="Mainline/Widget"\r
9572 file="readme.txt"\r
9573 recursive="true"\r
9574 label="Release 1.0.1"\r
9575 overwritelabel="false"\r
9576 comment="This labels the final build for the release of Widget 1.0.1."\r
9577 />\r
9578 </code>\r
9579 </example>\r
9580 <example>\r
9581 <para>\r
9582 Label all files under the 'Mainline/Widget' repository recursively in \r
9583 the 'Widget 1.0' branch with 'Release 1.0.1' and no comments.\r
9584 </para>\r
9585 <code>\r
9586 <sscmlabel\r
9587 serverconnect="localhost:4900"\r
9588 serverlogin="administrator:"\r
9589 branch="Widget 1.0"\r
9590 repository="Mainline/Widget"\r
9591 file="readme.txt"\r
9592 recursive="true"\r
9593 label="Release 1.0.1"\r
9594 />\r
9595 </code>\r
9596 </example>\r
9597 <example>\r
9598 <para>\r
9599 Label version 4 of the file 'Mainline/Widget/Widget.java' in the \r
9600 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. An \r
9601 existing 'Release 1.0.1' label on this file to be moved to version 4 \r
9602 of the file.\r
9603 </para>\r
9604 <code>\r
9605 <sscmlabel\r
9606 serverconnect="localhost:4900"\r
9607 serverlogin="administrator:"\r
9608 branch="Widget 1.0"\r
9609 repository="Mainline/Widget"\r
9610 file="readme.txt"\r
9611 label="Release 1.0.1"\r
9612 overwritelabel=" true" \r
9613 comment=" This labels the final build for the release of Widget 1.0.1." \r
9614 version=" 4" \r
9615 />\r
9616 </code>\r
9617 </example>\r
9618 </member>\r
9619 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.WriteCommandLineArguments(System.Text.StringBuilder)">\r
9620 <summary>\r
9621 Writes the task-specific arguments to the specified \r
9622 <see cref="T:System.Text.StringBuilder"/>.\r
9623 </summary>\r
9624 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
9625 </member>\r
9626 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Branch">\r
9627 <summary>\r
9628 Surround SCM branch name. The default is pulled from the local \r
9629 working directory.\r
9630 </summary>\r
9631 </member>\r
9632 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Repository">\r
9633 <summary>\r
9634 Surround SCM repository path. The default is pulled from the local \r
9635 working directory.\r
9636 </summary>\r
9637 </member>\r
9638 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.File">\r
9639 <summary>\r
9640 File or repository name. Can be / or empty, which means the \r
9641 repository specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Repository"/> attribute\r
9642 or the default repository.\r
9643 </summary>\r
9644 </member>\r
9645 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Label">\r
9646 <summary>\r
9647 The new label to create.\r
9648 </summary>\r
9649 </member>\r
9650 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Recursive">\r
9651 <summary>\r
9652 Recursively label all files. The default is <see langword="false" />.\r
9653 </summary>\r
9654 </member>\r
9655 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Overwrite">\r
9656 <summary>\r
9657 Overwrite the existing label. The default is <see langword="false" />.\r
9658 </summary>\r
9659 </member>\r
9660 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Comment">\r
9661 <summary>\r
9662 Comment for the label.\r
9663 </summary>\r
9664 </member>\r
9665 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Version">\r
9666 <summary>\r
9667 The file version to label. Ignored if a filename is not specified in \r
9668 the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.File"/> attribute.\r
9669 </summary>\r
9670 </member>\r
9671 <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze">\r
9672 <summary>\r
9673 Unlocks frozen branches for a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>\r
9674 repository.\r
9675 </summary>\r
9676 <example>\r
9677 <para>\r
9678 Unfreeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the \r
9679 server at localhost, port 4900 with username 'administrator' and a \r
9680 blank password.\r
9681 </para>\r
9682 <code>\r
9683 <sscmunfreeze\r
9684 serverconnect="localhost:4900"\r
9685 serverlogin="administrator:"\r
9686 mainline="Mainline"\r
9687 branch="Widget 1.0"\r
9688 />\r
9689 </code>\r
9690 </example>\r
9691 </member>\r
9692 <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.WriteCommandLineArguments(System.Text.StringBuilder)">\r
9693 <summary>\r
9694 Writes the task-specific arguments to the specified \r
9695 <see cref="T:System.Text.StringBuilder"/>.\r
9696 </summary>\r
9697 <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>\r
9698 </member>\r
9699 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.Branch">\r
9700 <summary>\r
9701 Surround SCM branch name.\r
9702 </summary>\r
9703 </member>\r
9704 <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.Mainline">\r
9705 <summary>\r
9706 Surround SCM mainline branch name. The default is pulled from the local working directory.\r
9707 </summary>\r
9708 </member>\r
9709 <member name="T:NAnt.Contrib.Tasks.Svn.AbstractSvnTask">\r
9710 <summary>\r
9711 A base class for creating tasks for executing CVS client commands on a \r
9712 CVS repository.\r
9713 </summary>\r
9714 </member>\r
9715 <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_HOME">\r
9716 <summary>\r
9717 An environment variable that holds path information about where\r
9718 svn is located.\r
9719 </summary>\r
9720 </member>\r
9721 <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.ARG_PREFIX">\r
9722 <summary>\r
9723 The prefix used for command arguments.\r
9724 </summary>\r
9725 </member>\r
9726 <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_EXE">\r
9727 <summary>\r
9728 The name of the svn executable.\r
9729 </summary>\r
9730 </member>\r
9731 <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_RSH">\r
9732 <summary>\r
9733 Environment variable that holds the executable name that is used for\r
9734 ssh communication.\r
9735 </summary>\r
9736 </member>\r
9737 <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_PASSFILE">\r
9738 <summary>\r
9739 Name of the password file that is used to cash password settings.\r
9740 </summary>\r
9741 </member>\r
9742 <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.#ctor">\r
9743 <summary>\r
9744 Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.AbstractCvsTask"/> \r
9745 class.\r
9746 </summary>\r
9747 </member>\r
9748 <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.PrepareProcess(System.Diagnostics.Process)">\r
9749 <summary>\r
9750 Build up the command line arguments, determine which executable is being\r
9751 used and find the path to that executable and set the working \r
9752 directory.\r
9753 </summary>\r
9754 <param name="process">The process to prepare.</param>\r
9755 </member>\r
9756 <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.AppendCommandOptions">\r
9757 <summary>\r
9758 Append the command line options or commen names for the options\r
9759 to the generic options collection. This is then piped to the\r
9760 command line as a switch.\r
9761 </summary>\r
9762 </member>\r
9763 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.VcsExeName">\r
9764 <summary>\r
9765 The name of the executable.\r
9766 </summary>\r
9767 </member>\r
9768 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.PassFileName">\r
9769 <summary>\r
9770 The name of the password file.\r
9771 </summary>\r
9772 </member>\r
9773 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.VcsHomeEnv">\r
9774 <summary>\r
9775 Name of the home environment variable.\r
9776 </summary>\r
9777 </member>\r
9778 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SshEnv">\r
9779 <summary>\r
9780 The name of the ssh/ rsh environment variable.\r
9781 </summary>\r
9782 </member>\r
9783 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.ExeName">\r
9784 <summary>\r
9785 The full path of the svn executable.\r
9786 </summary>\r
9787 </member>\r
9788 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Root">\r
9789 <summary>\r
9790 <para>\r
9791 TODO: Add more documentation when I understand all svn root possibilities/\r
9792 protocols.\r
9793 The svn root is usually in the form of a URL from which the server, protocol\r
9794 and path information can be derived. Although the path to the repository\r
9795 can also be determined from this the information is more implicit\r
9796 than explicit. For example a subversion root URL of:\r
9798 http://svn.collab.net/repos/svn/trunk/doc/book/tools\r
9800 would have the following components:\r
9801 protocol: http/ web_dav\r
9802 username: anonymous\r
9803 servername: svn.collab.net\r
9804 repository: /repos/svn\r
9805 server path: /trunk/doc/book/tools\r
9806 \r
9807 In addition the revision path or branch can also be determined as\r
9808 subversion stores this information as a seperate physical directory.\r
9809 In this example:\r
9810 \r
9811 revision: trunk\r
9812 </para>\r
9813 </summary>\r
9814 </member>\r
9815 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.UserName">\r
9816 <summary>\r
9817 The user performing the checkout.\r
9818 </summary>\r
9819 </member>\r
9820 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Password">\r
9821 <summary>\r
9822 The pasword to use to login to svn.\r
9823 </summary>\r
9824 </member>\r
9825 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Interactive">\r
9826 <summary>\r
9827 Indicates whether the task should be interactive or not. This is\r
9828 set to <see langword="false" /> by default, and I don't see a reason\r
9829 to expose this to the NAnt task.\r
9830 </summary>\r
9831 </member>\r
9832 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Ssh">\r
9833 <summary>\r
9834 The executable to use for ssh communication.\r
9835 </summary>\r
9836 </member>\r
9837 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.CommandName">\r
9838 <summary>\r
9839 The command to execute.\r
9840 </summary>\r
9841 </member>\r
9842 <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.IsRootUsed">\r
9843 <summary>\r
9844 Determines if the root is used for the command based on \r
9845 the command name. Returns <code>true</code> if the root\r
9846 is used, otherwise returns <code>false</code>.\r
9847 </summary>\r
9848 </member>\r
9849 <member name="T:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask">\r
9850 <summary>\r
9851 Executes the svn checkout command.\r
9852 </summary>\r
9853 <example>\r
9854 <para>Checkout Gentle.NET.</para>\r
9855 <code>\r
9856 <![CDATA[\r
9857 <svn-update\r
9858 destination="c:/dev/src/gentle.net" \r
9859 uri="http://www.mertner.com/svn/repos/projects/gentle" \r
9860 recursive="true"\r
9861 quiet="true"\r
9862 username="anonymoose"\r
9863 password="Canada" \r
9864 revision="HEAD"\r
9865 cache-auth="false"\r
9866 config-dir="c:\home"\r
9867 />\r
9868 ]]>\r
9869 </code>\r
9870 </example>\r
9871 </member>\r
9872 <member name="M:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.#ctor">\r
9873 <summary>\r
9874 Initialize the task, and set the default parameters.\r
9875 </summary>\r
9876 </member>\r
9877 <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.CommandName">\r
9878 <summary>\r
9879 Gets the svn command to execute.\r
9880 </summary>\r
9881 <value>\r
9882 The svn command to execute. The default value is "checkout".\r
9883 </value>\r
9884 </member>\r
9885 <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.Quiet">\r
9886 <summary>\r
9887 Determines if the output should be minimized. The default is\r
9888 <see langword="true" />.\r
9889 </summary>\r
9890 </member>\r
9891 <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.Recursive">\r
9892 <summary>\r
9893 <see langword="true" /> if the command should be executed recursively.\r
9894 The default is <see langword="true" />.\r
9895 </summary>\r
9896 </member>\r
9897 <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.Revision">\r
9898 <summary>\r
9899 The revision to checkout. If no revision is specified then subversion\r
9900 will return the <code>HEAD</code>.\r
9901 </summary>\r
9902 <remarks>\r
9903 A revision argument can be one of:\r
9904 NUMBER revision number\r
9905 "{" DATE "}" revision at start of the date\r
9906 "HEAD" latest in repository\r
9907 "BASE" base rev of item's working copy\r
9908 "COMMITTED" last commit at or before BASE\r
9909 "PREV" revision just before COMMITTED\r
9910 </remarks>\r
9911 </member>\r
9912 <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.CacheAuth">\r
9913 <summary>\r
9914 <see langword="true" /> if the authentiction token should be cached\r
9915 locally.\r
9916 </summary>\r
9917 </member>\r
9918 <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.ConfigDir">\r
9919 <summary>\r
9920 The location of the configuration directory.\r
9921 </summary>\r
9922 </member>\r
9923 <member name="T:NAnt.Contrib.Tasks.Svn.SvnTask">\r
9924 <summary>\r
9925 Executes the svn command specified by the command attribute.\r
9926 </summary>\r
9927 <example>\r
9928 <para>Checkout Gentle.NET.</para>\r
9929 <code>\r
9930 <![CDATA[\r
9931 <svn command="checkout" \r
9932 destination="c:\dev\src\gentle.net" \r
9933 svnroot="http://www.mertner.com/svn/repos/projects/gentle" \r
9934 password="" />\r
9935 ]]>\r
9936 </code>\r
9937 </example>\r
9938 </member>\r
9939 <member name="P:NAnt.Contrib.Tasks.Svn.SvnTask.CommandName">\r
9940 <summary>\r
9941 The svn command to execute.\r
9942 </summary>\r
9943 </member>\r
9944 <member name="T:NAnt.Contrib.Tasks.Svn.SvnUpdateTask">\r
9945 <summary>\r
9946 Executes the svn update specified by the command attribute.\r
9947 </summary>\r
9948 <example>\r
9949 <para>Update Gentle.NET.</para>\r
9950 <code>\r
9951 <![CDATA[\r
9952 <svn-update\r
9953 destination="c:\dev\src\gentle.net" \r
9954 uri="http://www.mertner.com/svn/repos/projects/gentle" \r
9955 recursive="true"\r
9956 quiet="true"\r
9957 username="anonymoose"\r
9958 password="Canada" \r
9959 revision="HEAD"\r
9960 cach-auth="false"\r
9961 config-dir="c:\home"\r
9962 />\r
9963 ]]>\r
9964 </code>\r
9965 </example>\r
9966 </member>\r
9967 <member name="P:NAnt.Contrib.Tasks.Svn.SvnUpdateTask.CommandName">\r
9968 <summary>\r
9969 Gets the svn command to execute.\r
9970 </summary>\r
9971 <value>\r
9972 The svn command to execute. The default value is "update".\r
9973 </value>\r
9974 </member>\r
9975 <member name="T:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory">\r
9976 <summary>\r
9977 Creates or modifies a virtual directory of a web site hosted on Internet\r
9978 Information Server.\r
9979 </summary>\r
9980 <remarks>\r
9981 <para>\r
9982 If the virtual directory does not exist it is created, and if it already\r
9983 exists it is modified. Only the IIS-properties specified will be set. If set\r
9984 by other means (e.g. the Management Console), the unspecified properties retain their current value, \r
9985 otherwise they are inherited from the parent. \r
9986 </para>\r
9987 <para>\r
9988 For a list of optional parameters see <see href="ms-help://MS.VSCC/MS.MSDNVS/iisref/html/psdk/asp/aore8v5e.htm">IIsWebVirtualDir</see>.\r
9989 </para>\r
9990 <para>\r
9991 More information on metabase parameters is available <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/iissdk/iis/alphabeticmetabasepropertylist.asp">here</see>.\r
9992 </para>\r
9993 </remarks>\r
9994 <example>\r
9995 <para>\r
9996 Create a virtual directory named <c>Temp</c> pointing to <c>c:\temp</c> \r
9997 on the local machine.\r
9998 </para>\r
9999 <code>\r
10000 <![CDATA[\r
10001 <mkiisdir dirpath="c:\temp" vdirname="Temp" />\r
10002 ]]>\r
10003 </code>\r
10004 </example>\r
10005 <example>\r
10006 <para>\r
10007 Create a virtual directory named <c>Temp</c> pointing to <c>c:\temp</c> \r
10008 on machine <c>Staging</c>.\r
10009 </para>\r
10010 <code>\r
10011 <![CDATA[\r
10012 <mkiisdir iisserver="Staging" dirpath="c:\temp" vdirname="Temp" />\r
10013 ]]>\r
10014 </code>\r
10015 </example>\r
10016 <example>\r
10017 <para>\r
10018 Configure the home directory of for http://svc.here.dev/ to point to\r
10019 D:\Develop\Here and require authentication\r
10020 </para>\r
10021 <code>\r
10022 <![CDATA[\r
10023 <mkiisdir iisserver="svc.here.dev" dirpath="D:\Develop\Here" vdirname="/" authanonymous="false"/>\r
10024 ]]>\r
10025 </code>\r
10026 </example>\r
10027 <example>\r
10028 <para>\r
10029 Create a virtual directory named <c>WebServices/Dev</c> pointing to \r
10030 <c>c:\MyProject\dev</c> on the web site running on port <c>81</c> of\r
10031 machine <c>MyHost</c>.\r
10032 </para>\r
10033 <code>\r
10034 <![CDATA[\r
10035 <mkiisdir iisserver="MyHost:81" dirpath="c:\MyProject\dev" vdirname="WebServices/Dev" />\r
10036 ]]>\r
10037 </code>\r
10038 Note that if <c>WebServices</c> is neither an existing virtual directory nor an\r
10039 existing physical subdirectory of the web root, your IIS Management Console\r
10040 will get confused. Even though <c>http://MyHost:81/WebServices/Dev/theService.asmx</c>\r
10041 may be a perfectly working webservice, the Management Console will not show it.\r
10042 </example>\r
10043 </member>\r
10044 <member name="T:NAnt.Contrib.Tasks.Web.WebBase">\r
10045 <summary>\r
10046 Base class for all IIS-related task.\r
10047 </summary>\r
10048 <remarks>\r
10049 Basically this class hold the logic to determine the IIS version as well\r
10050 as the IIS server/port determination/checking logic.\r
10051 </remarks>\r
10052 </member>\r
10053 <member name="P:NAnt.Contrib.Tasks.Web.WebBase.VirtualDirectory">\r
10054 <summary>\r
10055 Name of the IIS virtual directory.\r
10056 </summary>\r
10057 </member>\r
10058 <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Server">\r
10059 <summary>\r
10060 The IIS server, which can be specified using the format <c>[host]:[port]</c>. \r
10061 The default is <c>localhost:80</c>.\r
10062 </summary>\r
10063 <remarks>\r
10064 <para>\r
10065 This allows for targeting a specific virtual site on a physical box.\r
10066 </para>\r
10067 </remarks>\r
10068 </member>\r
10069 <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Website">\r
10070 <summary>\r
10071 The website on the IIS server. \r
10072 </summary>\r
10073 <remarks>\r
10074 <para>\r
10075 This allows for targeting a specific virtual site on a physical box.\r
10076 </para>\r
10077 </remarks>\r
10078 </member>\r
10079 <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Version">\r
10080 <summary>\r
10081 Gets the version of IIS corresponding with the current OS.\r
10082 </summary>\r
10083 <value>\r
10084 The version of IIS corresponding with the current OS.\r
10085 </value>\r
10086 </member>\r
10087 <member name="T:NAnt.Contrib.Tasks.Web.WebBase.IISVersion">\r
10088 <summary>\r
10089 Defines the IIS versions supported by the IIS tasks.\r
10090 </summary>\r
10091 </member>\r
10092 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppFriendlyName">\r
10093 <summary>\r
10094 The user-friendly name of the package or application.\r
10095 </summary>\r
10096 </member>\r
10097 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirPath">\r
10098 <summary>\r
10099 The file system path.\r
10100 </summary>\r
10101 </member>\r
10102 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute">\r
10103 <summary>\r
10104 Indicates whether the file or the contents of the folder may be \r
10105 executed, regardless of file type. The default is <see langword="false" />.\r
10106 </summary>\r
10107 </member>\r
10108 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteExecute">\r
10109 <summary>\r
10110 Indicates whether remote requests to execute applications are denied; \r
10111 only requests from the same computer as the IIS server succeed if \r
10112 <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> is set to <see langword="true"/>. You \r
10113 cannot set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteExecute"/> to <see langword="false"/>\r
10114 to enable remote requests, and set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> to \r
10115 <see langword="false"/> to disable local requests. The default is\r
10116 <see langword="false"/>.\r
10117 </summary>\r
10118 </member>\r
10119 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteRead">\r
10120 <summary>\r
10121 Indicates whether remote requests to view files are denied; \r
10122 only requests from the same computer as the IIS server succeed if \r
10123 <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> is set to <see langword="true"/>. You \r
10124 cannot set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteRead"/> to <see langword="false"/>\r
10125 to enable remote requests, and set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessRead"/> to \r
10126 <see langword="false"/> to disable local requests. The default is\r
10127 <see langword="false"/>.\r
10128 </summary>\r
10129 </member>\r
10130 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteScript">\r
10131 <summary>\r
10132 A value of true indicates that remote requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests.\r
10133 </summary>\r
10134 </member>\r
10135 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteWrite">\r
10136 <summary>\r
10137 indicates that remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests.\r
10138 </summary>\r
10139 </member>\r
10140 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessRead">\r
10141 <summary>\r
10142 Indicates whether the file or the contents of the folder may be \r
10143 read. The default is <see langword="true" />.\r
10144 </summary>\r
10145 </member>\r
10146 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSource">\r
10147 <summary>\r
10148 Indicates whether users are allowed to access source code if either \r
10149 Read or Write permissions are set. The default is <see langword="false" />.\r
10150 </summary>\r
10151 </member>\r
10152 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessScript">\r
10153 <summary>\r
10154 Indicates whether the file or the contents of the folder may be \r
10155 executed if they are script files or static content. The default\r
10156 is <see langword="true" />.\r
10157 </summary>\r
10158 </member>\r
10159 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSsl">\r
10160 <summary>\r
10161 Indicates whether file access requires SSL file permission processing, \r
10162 with or without a client certificate. The default is <see langword="false" />.\r
10163 </summary>\r
10164 </member>\r
10165 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccesssSl128">\r
10166 <summary>\r
10167 Indicates whether file access requires SSL file permission processing \r
10168 with a minimum key size of 128 bits, with or without a client \r
10169 certificate. The default is <see langword="false" />.\r
10170 </summary>\r
10171 </member>\r
10172 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslMapCert">\r
10173 <summary>\r
10174 Indicates whether SSL file permission processing maps a client \r
10175 certificate to a Microsoft Windows ® operating system user-account. \r
10176 <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert"/> must also be set to \r
10177 <see langword="true"/> for the mapping to occur. The default is\r
10178 <see langword="false"/>.\r
10179 </summary>\r
10180 </member>\r
10181 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert">\r
10182 <summary>\r
10183 Indicates whether SSL file access processing requests a certificate \r
10184 from the client. The default is <see langword="false" />.\r
10185 </summary>\r
10186 </member>\r
10187 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslRequireCert">\r
10188 <summary>\r
10189 Indicates whether SSL file access processing requests a certificate \r
10190 from the client. If the client provides no certificate, the connection \r
10191 is closed. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert"/> must also be set to \r
10192 <see langword="true"/> when using <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslRequireCert"/>.\r
10193 The default is <see langword="false"/>.\r
10194 </summary>\r
10195 </member>\r
10196 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessWrite">\r
10197 <summary>\r
10198 Indicates whether users are allowed to upload files and their \r
10199 associated properties to the enabled directory on your server or \r
10200 to change content in a Write-enabled file. The default is\r
10201 <see langword="false" />.\r
10202 </summary>\r
10203 </member>\r
10204 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AnonymousPasswordSync">\r
10205 <summary>\r
10206 Indicates whether IIS should handle the user password for anonymous \r
10207 users attempting to access resources. The default is \r
10208 <see langword="false" />.\r
10209 </summary>\r
10210 </member>\r
10211 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppCreate">\r
10212 <summary>\r
10213 Specifies what type of application to create for this virtual directory. \r
10214 The default is <see cref="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.Pooled"/>.\r
10215 </summary>\r
10216 </member>\r
10217 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppAllowClientDebug">\r
10218 <summary>\r
10219 Specifies whether ASP client-side debugging is enabled. The default\r
10220 is <see langword="false" />.\r
10221 </summary>\r
10222 </member>\r
10223 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppAllowDebugging">\r
10224 <summary>\r
10225 Specifies whether ASP debugging is enabled on the server. The default\r
10226 is <see langword="false" />.\r
10227 </summary>\r
10228 </member>\r
10229 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspAllowSessionState">\r
10230 <summary>\r
10231 Enables session state persistence for the ASP application. The \r
10232 default is <see langword="true" />.\r
10233 </summary>\r
10234 </member>\r
10235 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspBufferingOn">\r
10236 <summary>\r
10237 Specifies whether output from an ASP application will be buffered. \r
10238 If <see langword="true" />, all output from the application is \r
10239 collected in the buffer before the buffer is flushed to the client. \r
10240 With buffering on, the ASP application has to completely process the \r
10241 ASP script before the client receives any output. The default is \r
10242 <see langword="true" />.\r
10243 </summary>\r
10244 </member>\r
10245 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableApplicationRestart">\r
10246 <summary>\r
10247 Determines whether an ASP application can be automatically restarted. \r
10248 When changes are made to Global.asa or metabase properties that affect \r
10249 an application, the application will not restart unless the \r
10250 <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableApplicationRestart"/> property is set to \r
10251 <see langword="false"/>. The default is <see langword="true"/>.\r
10252 </summary>\r
10253 <remarks>\r
10254 When this property is changed from <see langword="false"/> to \r
10255 <see langword="true"/>, the application immediately restarts.\r
10256 </remarks>\r
10257 </member>\r
10258 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableAspHtmlFallback">\r
10259 <summary>\r
10260 Controls the behavior of ASP when a new request is to be rejected \r
10261 due to a full request queue. If <see langword="true" />, an .htm file \r
10262 with a similar name as the requested .asp file, will be sent instead \r
10263 of the .asp file. The naming convention for the .htm file is the \r
10264 name of the .asp file with _asp appended. The default is\r
10265 <see langword="false" />.\r
10266 </summary>\r
10267 </member>\r
10268 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableChunkedEncoding">\r
10269 <summary>\r
10270 Specifies whether HTTP 1.1 chunked transfer encoding is enabled for \r
10271 the World Wide Web Publishing Service (WWW service). The default is\r
10272 <see langword="false" />.\r
10273 </summary>\r
10274 </member>\r
10275 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog">\r
10276 <summary>\r
10277 Specifies which ASP errors are written to the Windows event log. \r
10278 </summary>\r
10279 <remarks>\r
10280 <para>\r
10281 ASP errors are written to the client browser and to the IIS log files \r
10282 by default. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>\r
10283 by default, and is modified by <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> in \r
10284 the following way:\r
10285 </para>\r
10286 <para>\r
10287 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="false"/>, \r
10288 then ASP errors are not written to the Windows event log, regardless \r
10289 of the value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.\r
10290 </para>\r
10291 <para> \r
10292 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>, \r
10293 and if IIS fails to write an item to the IIS log file, the item is \r
10294 written to the Windows event log as a warning, regardless of the \r
10295 value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>. \r
10296 </para>\r
10297 <para>\r
10298 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>\r
10299 and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="false"/>, \r
10300 then only the most serious ASP errors are sent to the Windows event log. \r
10301 Serious ASP error numbers are: 100, 101, 102, 103, 104, 105, 106, 107, \r
10302 115, 190, 191, 192, 193, 194, 240, 241, and 242.\r
10303 </para>\r
10304 <para>\r
10305 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>\r
10306 and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="true"/>, \r
10307 then all ASP errors are written to the Windows event log.\r
10308 </para>\r
10309 </remarks>\r
10310 </member>\r
10311 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableParentPaths">\r
10312 <summary>\r
10313 Specifies whether an ASP page allows paths relative to the current \r
10314 directory. The default is <see langword="true" />.\r
10315 </summary>\r
10316 </member>\r
10317 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableTypelibCache">\r
10318 <summary>\r
10319 Specifies whether type libraries are cached on the server. The \r
10320 default is <see langword="true" />.\r
10321 </summary>\r
10322 <remarks>\r
10323 <para>\r
10324 The World Wide Web Publishing Service (WWW service) setting for \r
10325 this property is applicable to all in-process and pooled out-of-process\r
10326 application nodes, at all levels.\r
10327 </para>\r
10328 <para>\r
10329 Metabase settings at the Web server level or lower are ignored\r
10330 for in-process and pooled out-of-process applications. However, \r
10331 settings at the Web server level or lower are used if that node\r
10332 is an isolated out-of-process application.\r
10333 </para>\r
10334 </remarks>\r
10335 </member>\r
10336 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspExceptionCatchEnable">\r
10337 <summary>\r
10338 Specifies whether ASP pages trap exceptions thrown by components. \r
10339 If set to <see langword="false" />, the Microsoft Script Debugger tool\r
10340 does not catch exceptions sent by the component that you are debugging.\r
10341 The default is <see langword="true" />.\r
10342 </summary>\r
10343 </member>\r
10344 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests">\r
10345 <summary>\r
10346 Controls whether the Web server writes ASP errors to the application \r
10347 section of the Windows event log. The default is <see langword="true"/>.\r
10348 </summary>\r
10349 <remarks>\r
10350 <para>\r
10351 ASP errors are written to the client browser and to the IIS log files \r
10352 by default. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>\r
10353 by default, and is modified by <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> in \r
10354 the following way:\r
10355 </para>\r
10356 <para>\r
10357 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="false"/>, \r
10358 then ASP errors are not written to the Windows event log, regardless \r
10359 of the value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.\r
10360 </para>\r
10361 <para> \r
10362 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>, \r
10363 and if IIS fails to write an item to the IIS log file, the item is \r
10364 written to the Windows event log as a warning, regardless of the \r
10365 value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>. \r
10366 </para>\r
10367 <para>\r
10368 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>\r
10369 and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="false"/>, \r
10370 then only the most serious ASP errors are sent to the Windows event log. \r
10371 Serious ASP error numbers are: 100, 101, 102, 103, 104, 105, 106, 107, \r
10372 115, 190, 191, 192, 193, 194, 240, 241, and 242.\r
10373 </para>\r
10374 <para>\r
10375 If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>\r
10376 and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="true"/>, \r
10377 then all ASP errors are written to the Windows event log.\r
10378 </para>\r
10379 </remarks>\r
10380 </member>\r
10381 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspScriptErrorSentToBrowser">\r
10382 <summary>\r
10383 Specifies whether the Web server writes debugging specifics\r
10384 (file name, error, line number, description) to the client browser, \r
10385 in addition to logging them to the Windows Event Log. The default\r
10386 is <see langword="true" />.\r
10387 </summary>\r
10388 </member>\r
10389 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspThreadGateEnabled">\r
10390 <summary>\r
10391 Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5).\r
10392 The default is <see langword="false" />.\r
10393 </summary>\r
10394 <remarks>\r
10395 IIS performs thread gating to dynamically control the number of \r
10396 concurrently executing threads, in response to varying load conditions. \r
10397 </remarks>\r
10398 </member>\r
10399 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspTrackThreadingModel">\r
10400 <summary>\r
10401 Specifies whether IIS checks the threading model of any components \r
10402 that your application creates. The default is <see langword="false" />.\r
10403 </summary>\r
10404 </member>\r
10405 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthAnonymous">\r
10406 <summary>\r
10407 Specifies Anonymous authentication as one of the possible authentication\r
10408 schemes returned to clients as being available. The default is\r
10409 <see langword="true" />.\r
10410 </summary>\r
10411 </member>\r
10412 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthBasic">\r
10413 <summary>\r
10414 Specifies Basic authentication as one of the possible authentication \r
10415 schemes returned to clients as being available. The default is\r
10416 <see langword="false" />.\r
10417 </summary>\r
10418 </member>\r
10419 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthNtlm">\r
10420 <summary>\r
10421 Specifies Integrated Windows authentication as one of the possible \r
10422 authentication schemes returned to clients as being available. The\r
10423 default is <see langword="false" />.\r
10424 </summary>\r
10425 </member>\r
10426 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequest">\r
10427 <summary>\r
10428 Specifies that authentication persists only for a single request on \r
10429 a connection. IIS resets the authentication at the end of each request, \r
10430 and forces re-authentication on the next request of the session.\r
10431 </summary>\r
10432 <remarks>\r
10433 [IIS 6.0] When the AuthPersistSingleRequest flag is set to true when \r
10434 using NTLM authentication, IIS 6.0 automatically reauthenticates every \r
10435 request, even those on the same connection.\r
10436 </remarks>\r
10437 </member>\r
10438 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequestIfProxy">\r
10439 <summary>\r
10440 Specifies authentication will persist only across single requests \r
10441 on a connection if the connection is by proxy. Applies to IIS 5.0 \r
10442 and 5.1. The default is <see langword="false" />\r
10443 </summary>\r
10444 <remarks>\r
10445 IIS will reset the authentication at the end of the request if the current authenticated \r
10446 request is by proxy and it is not the special case where IIS is running MSPROXY\r
10447 </remarks>\r
10448 </member>\r
10449 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequestAlwaysIfProxy">\r
10450 <summary>\r
10451 Specifies whether authentication is valid for a single request \r
10452 if by proxy. IIS will reset the authentication at the end of the \r
10453 request and force re-authentication on the next request if the \r
10454 current authenticated request is by proxy of any type. Applies to\r
10455 IIS 5.0 and 5.1. The default is <see langword="false" />.\r
10456 </summary>\r
10457 </member>\r
10458 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CacheControlNoCache">\r
10459 <summary>\r
10460 Specifies whether the HTTP 1.1 directive to prevent caching of content\r
10461 should be sent to clients. The default is <see langword="false" />.\r
10462 </summary>\r
10463 </member>\r
10464 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CacheIsapi">\r
10465 <summary>\r
10466 Indicates whether ISAPI extensions are cached in memory after first \r
10467 use. The default is <see langword="true" />.\r
10468 </summary>\r
10469 </member>\r
10470 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.ContentIndexed">\r
10471 <summary>\r
10472 Specifies whether the installed content indexer should index content \r
10473 under this directory tree. The default is <see langword="true" />.\r
10474 </summary>\r
10475 </member>\r
10476 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CpuAppEnabled">\r
10477 <summary>\r
10478 Specifies whether process accounting and throttling should be performed \r
10479 for ISAPI extensions and ASP applications. The default is\r
10480 <see langword="true" />.\r
10481 </summary>\r
10482 </member>\r
10483 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CpuCgiEnabled">\r
10484 <summary>\r
10485 Indicates whether IIS should perform process accounting for CGI \r
10486 applications. The default is <see langword="true" />.\r
10487 </summary>\r
10488 </member>\r
10489 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CreateCgiWithNewConsole">\r
10490 <summary>\r
10491 Indicates whether a CGI application runs in its own console. The\r
10492 default is <see langword="false" />.\r
10493 </summary>\r
10494 </member>\r
10495 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CreateProcessAsUser">\r
10496 <summary>\r
10497 Specifies whether a CGI process is created in the system context \r
10498 or in the context of the requesting user. The default is\r
10499 <see langword="true" />.\r
10500 </summary>\r
10501 </member>\r
10502 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowDate">\r
10503 <summary>\r
10504 Specifies whether date information is displayed when browsing \r
10505 directories. The default is <see langword="true" />.\r
10506 </summary>\r
10507 </member>\r
10508 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowExtension">\r
10509 <summary>\r
10510 Specifies whether file extensions are displayed when browsing \r
10511 directories. The default is <see langword="true" />.\r
10512 </summary>\r
10513 </member>\r
10514 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowLongDate">\r
10515 <summary>\r
10516 Specifies whether date information is displayed in extended format \r
10517 when displaying directories. The default is <see langword="true" />.\r
10518 </summary>\r
10519 </member>\r
10520 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowSize">\r
10521 <summary>\r
10522 Specifies whether file size information is displayed when displaying \r
10523 directories. The default is <see langword="true" />.\r
10524 </summary>\r
10525 </member>\r
10526 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowTime">\r
10527 <summary>\r
10528 Specifies whether file creation time is displayed when browsing \r
10529 directories. The default is <see langword="true" />.\r
10530 </summary>\r
10531 </member>\r
10532 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DontLog">\r
10533 <summary>\r
10534 Specifies whether client requests are written to the IIS log files.\r
10535 The default is <see langword="false" />.\r
10536 </summary>\r
10537 </member>\r
10538 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDefaultDoc">\r
10539 <summary>\r
10540 When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed.\r
10541 </summary>\r
10542 </member>\r
10543 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDirBrowsing">\r
10544 <summary>\r
10545 Specifies whether directory browsing is enabled. The default is\r
10546 <see langword="false" />.\r
10547 </summary>\r
10548 </member>\r
10549 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDocFooter">\r
10550 <summary>\r
10551 Enables or disables custom footers. The default is \r
10552 <see langword="false" />.\r
10553 </summary>\r
10554 </member>\r
10555 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableReverseDns">\r
10556 <summary>\r
10557 Enables or disables reverse Domain Name Server (DNS) lookups for \r
10558 the World Wide Web Publishing Service (WWW service). The default is\r
10559 <see langword="false" />.\r
10560 </summary>\r
10561 </member>\r
10562 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.SsiExecDisable">\r
10563 <summary>\r
10564 Specifies whether server-side include (SSI) #exec directives are \r
10565 disabled under this path. The default is <see langword="false" />.\r
10566 </summary>\r
10567 </member>\r
10568 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncAuthenticationPassthrough">\r
10569 <summary>\r
10570 \r
10571 </summary>\r
10572 </member>\r
10573 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspScriptErrorMessage">\r
10574 <summary>\r
10575 \r
10576 </summary>\r
10577 </member>\r
10578 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DefaultDoc">\r
10579 <summary>\r
10580 One or more file names of default documents that will be returned to \r
10581 the client if no file name is included in the client's request.\r
10582 </summary>\r
10583 </member>\r
10584 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncUserName">\r
10585 <summary>\r
10586 Specifies the user name for Universal Naming Convention (UNC) virtual \r
10587 roots.\r
10588 </summary>\r
10589 </member>\r
10590 <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncPassword">\r
10591 <summary>\r
10592 Specifies the encrypted password used to gain access to UNC \r
10593 (Universal Naming Convention) virtual roots.\r
10594 </summary>\r
10595 </member>\r
10596 <member name="T:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType">\r
10597 <summary>\r
10598 The different ways a (virtual) directory in IIS can be configured \r
10599 as an application.\r
10600 </summary>\r
10601 </member>\r
10602 <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.None">\r
10603 <summary>\r
10604 Virtual directory is not configured as an application.\r
10605 </summary>\r
10606 </member>\r
10607 <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.InProcess">\r
10608 <summary>\r
10609 Virtual directory is configured as an in-process application.\r
10610 </summary>\r
10611 </member>\r
10612 <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.Pooled">\r
10613 <summary>\r
10614 Virtual directory is configured as a pooled out-of-process \r
10615 application. For IIS4 this is the same as <see cref="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.OutOfProcess"/>.\r
10616 </summary>\r
10617 </member>\r
10618 <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.OutOfProcess">\r
10619 <summary>\r
10620 Virtual directory is configured as an out-of-process application.\r
10621 </summary>\r
10622 </member>\r
10623 <member name="T:NAnt.Contrib.Tasks.Web.DeleteVirtualDirectory">\r
10624 <summary>\r
10625 Deletes a virtual directory from a given web site hosted on Internet \r
10626 Information Server.\r
10627 </summary>\r
10628 <example>\r
10629 <para>\r
10630 Delete a virtual directory named <c>Temp</c> from the web site running\r
10631 on port <c>80</c> of the local machine. If more than one web site is\r
10632 running on port <c>80</c>, take the web site bound to the hostname \r
10633 <c>localhost</c> if existent or bound to no hostname otherwise.\r
10634 </para>\r
10635 <code>\r
10636 <![CDATA[\r
10637 <deliisdir vdirname="Temp" />\r
10638 ]]>\r
10639 </code>\r
10640 </example>\r
10641 <example>\r
10642 <para>\r
10643 Delete a virtual directory named <c>Temp</c> from the website running \r
10644 on port <c>81</c> of machine <c>MyHost</c>.\r
10645 </para>\r
10646 <code>\r
10647 <![CDATA[\r
10648 <deliisdir iisserver="MyHost:81" vdirname="Temp" />\r
10649 ]]>\r
10650 </code>\r
10651 </example>\r
10652 </member>\r
10653 <member name="T:NAnt.Contrib.Tasks.Web.VirtualDirectoryInfo">\r
10654 <summary>\r
10655 Lists the configuration settings of a specified virtual directory in a\r
10656 web site hosted on Internet Information Server.\r
10657 </summary>\r
10658 <example>\r
10659 <para>\r
10660 List the settings of a virtual directory named <c>Temp</c>.\r
10661 </para>\r
10662 <code>\r
10663 <![CDATA[\r
10664 <iisdirinfo vdirname="Temp" />\r
10665 ]]>\r
10666 </code>\r
10667 </example>\r
10668 </member>\r
10669 <member name="T:NAnt.Contrib.Tasks.ADSIBaseTask">\r
10670 <summary>\r
10671 Base NAnt task for working with ADSI. This task contains only the path of the ADSI\r
10672 object that you want to work with.\r
10673 </summary>\r
10674 </member>\r
10675 <member name="P:NAnt.Contrib.Tasks.ADSIBaseTask.Path">\r
10676 <summary>\r
10677 The ADSI path of the location where we want to work with.\r
10678 </summary>\r
10679 </member>\r
10680 <member name="T:NAnt.Contrib.Tasks.ADSIGetPropertyTask">\r
10681 <summary>\r
10682 Used to get the value of a property from an ADSI object.\r
10683 </summary>\r
10684 </member>\r
10685 <member name="M:NAnt.Contrib.Tasks.ADSIGetPropertyTask.ExecuteTask">\r
10686 <summary>\r
10687 Sets the specified property\r
10688 </summary>\r
10689 </member>\r
10690 <member name="P:NAnt.Contrib.Tasks.ADSIGetPropertyTask.PropName">\r
10691 <summary>\r
10692 The name of the property to get.\r
10693 </summary>\r
10694 </member>\r
10695 <member name="P:NAnt.Contrib.Tasks.ADSIGetPropertyTask.StoreIn">\r
10696 <summary>\r
10697 The name of the property to store the value in.\r
10698 </summary>\r
10699 </member>\r
10700 <member name="T:NAnt.Contrib.Tasks.ADSISetPropertyTask">\r
10701 <summary>\r
10702 Sets a property on an ADSI object.\r
10703 </summary>\r
10704 <remarks>\r
10705 This task uses a heuristic to determine the type of the property in ADSI. The following cases are notable:\r
10706 <list type="bulleted">\r
10707 <item>If the property does not exist on the item, it is inserted as a string.</item>\r
10708 <item>If the property already exists, this method will attempt to preserve\r
10709 the type of the property. The types this method knows about are String,\r
10710 Boolean, and Int32.</item>\r
10711 <item>If the property exists and is an array, the value is added to \r
10712 the array, but only if it is not already present.</item>\r
10713 </list>\r
10714 </remarks>\r
10715 <example>\r
10716 <code>\r
10717 <![CDATA[\r
10718 <adsisetprop path="${iis.path}/Root" propname="AuthAnonymous" propvalue="true" />\r
10719 ]]>\r
10720 </code>\r
10721 </example>\r
10722 <example>\r
10723 <code>\r
10724 <![CDATA[\r
10725 <adsisetprop path="${iis.path}/Root/GWSSample">\r
10726 <properties>\r
10727 <option name="AuthBasic" value="false" />\r
10728 <option name="AuthNTLM" value="true" />\r
10729 </properties>\r
10730 </adsisetprop>\r
10731 ]]>\r
10732 </code>\r
10733 </example>\r
10734 </member>\r
10735 <member name="M:NAnt.Contrib.Tasks.ADSISetPropertyTask.ExecuteTask">\r
10736 <summary>\r
10737 Sets the specified property\r
10738 </summary>\r
10739 </member>\r
10740 <member name="M:NAnt.Contrib.Tasks.ADSISetPropertyTask.SetProperty(System.DirectoryServices.DirectoryEntry,System.String,System.String)">\r
10741 <summary>\r
10742 Sets the named property on the specified <see cref="T:System.DirectoryServices.DirectoryEntry"/> \r
10743 to the given value.\r
10744 </summary>\r
10745 <param name="entry">The <see cref="T:System.DirectoryServices.DirectoryEntry"/> we're modifying.</param>\r
10746 <param name="propertyName">The name of the property to set.</param>\r
10747 <param name="propertyValue">The value to set the property to.</param>\r
10748 <remarks>\r
10749 The following cases are notable:\r
10750 <list type="bulleted">\r
10751 <item>\r
10752 If the property does not exist on the item, it is inserted as a \r
10753 string.\r
10754 </item>\r
10755 <item>\r
10756 If the property already exists, this method will attempt to preserve\r
10757 the type of the property. The types this method knows about are \r
10758 <see cref="T:System.String"/>, <see creef="bool"/>, and <see cref="T:System.Int32"/>.\r
10759 </item>\r
10760 <item>\r
10761 If the property exists and is an array, the value is added to the \r
10762 array, but only if it's not already present.\r
10763 </item>\r
10764 </list>\r
10765 </remarks>\r
10766 </member>\r
10767 <member name="P:NAnt.Contrib.Tasks.ADSISetPropertyTask.PropertyName">\r
10768 <summary>\r
10769 The name of the property to set.\r
10770 </summary>\r
10771 </member>\r
10772 <member name="P:NAnt.Contrib.Tasks.ADSISetPropertyTask.PropertyValue">\r
10773 <summary>\r
10774 The new value of the property.\r
10775 </summary>\r
10776 </member>\r
10777 <member name="T:NAnt.Contrib.Tasks.Astyle">\r
10778 <summary>\r
10779 Formats source code in a given directory to a specified code format.\r
10780 </summary>\r
10781 <remarks>\r
10782 <para>\r
10783 Most examples inline have been produced by Tal Davidson and team and \r
10784 are part of the astyle documentation. They have been included in\r
10785 the task documentation as an easy reference.\r
10786 </para>\r
10787 NOTE: This task relies on the astyle.exe file being in your path variable.\r
10788 Please download the astyle.exe from http://astyle.sourceforge.net.\r
10789 </remarks>\r
10790 <example>\r
10791 <code>\r
10792 <![CDATA[\r
10793 <astyle style="NAnt" cleanup="true">\r
10794 <sources>\r
10795 <include name="**/**.cs" />\r
10796 </sources>\r
10797 </astyle>\r
10798 ]]>\r
10799 </code>\r
10800 </example>\r
10801 </member>\r
10802 <member name="F:NAnt.Contrib.Tasks.Astyle.DEFAULT_STYLE">\r
10803 <summary>\r
10804 The default style seems to be the closest to C# standards.\r
10805 </summary>\r
10806 </member>\r
10807 <member name="M:NAnt.Contrib.Tasks.Astyle.PrepareProcess(System.Diagnostics.Process)">\r
10808 <summary>\r
10809 Build up the command line arguments, determine which executable is \r
10810 being used and find the path to that executable and set the working \r
10811 directory.\r
10812 </summary>\r
10813 <param name="process">The process to prepare.</param>\r
10814 </member>\r
10815 <member name="M:NAnt.Contrib.Tasks.Astyle.SetCommandOption(System.String,System.String,System.Boolean)">\r
10816 <summary>\r
10817 Adds a new command option if none exists. If one does exist then\r
10818 the use switch is toggled on or of.\r
10819 </summary>\r
10820 <param name="name">The common name of the option.</param>\r
10821 <param name="value">The option value or command line switch of the option.</param>\r
10822 <param name="on"><see langword="true" /> if the option should be appended to the commandline, otherwise <see langword="false" />.</param>\r
10823 </member>\r
10824 <member name="M:NAnt.Contrib.Tasks.Astyle.AppendCommandOptions">\r
10825 <summary>\r
10826 Append the command line options or commen names for the options\r
10827 to the generic options collection. This is then piped to the\r
10828 command line as a switch.\r
10829 </summary>\r
10830 </member>\r
10831 <member name="M:NAnt.Contrib.Tasks.Astyle.AppendFiles">\r
10832 <summary>\r
10833 Append the files specified in the fileset to the command line argument.\r
10834 </summary>\r
10835 </member>\r
10836 <member name="P:NAnt.Contrib.Tasks.Astyle.CommandOptions">\r
10837 <summary>\r
10838 A collection of command line option switches.\r
10839 </summary>\r
10840 </member>\r
10841 <member name="P:NAnt.Contrib.Tasks.Astyle.Sources">\r
10842 <summary>\r
10843 Used to select the files to copy. \r
10844 </summary>\r
10845 </member>\r
10846 <member name="P:NAnt.Contrib.Tasks.Astyle.CommandLineArguments">\r
10847 <summary>\r
10848 The command-line arguments for the program.\r
10849 </summary>\r
10850 </member>\r
10851 <member name="P:NAnt.Contrib.Tasks.Astyle.Style">\r
10852 <summary>\r
10853 Indicate the preset style to use.\r
10854 <list type="table">\r
10855 <item>ansi\r
10856 <code>\r
10857 namespace foospace\r
10858 {\r
10859 int Foo()\r
10860 {\r
10861 if (isBar)\r
10862 {\r
10863 bar();\r
10864 return 1;\r
10865 }\r
10866 else\r
10867 return 0;\r
10868 }\r
10869 }\r
10870 </code>\r
10871 </item>\r
10872 <item>kr ( Kernighan&Ritchie )\r
10873 <code>\r
10874 namespace foospace {\r
10875 int Foo() {\r
10876 if (isBar) {\r
10877 bar();\r
10878 return 1;\r
10879 } else\r
10880 return 0;\r
10881 }\r
10882 }\r
10883 </code>\r
10884 </item>\r
10885 <item>linux\r
10886 <code>\r
10887 namespace foospace\r
10888 {\r
10889 int Foo()\r
10890 {\r
10891 if (isBar) {\r
10892 bar();\r
10893 return 1;\r
10894 } else\r
10895 return 0;\r
10896 }\r
10897 }\r
10898 </code>\r
10899 </item>\r
10900 <item>gnu\r
10901 <code>\r
10902 namespace foospace\r
10903 {\r
10904 int Foo()\r
10905 {\r
10906 if (isBar)\r
10907 {\r
10908 bar();\r
10909 return 1;\r
10910 }\r
10911 else\r
10912 return 0;\r
10913 }\r
10914 }\r
10915 </code>\r
10916 </item>\r
10917 <item>java\r
10918 <code>\r
10919 class foospace {\r
10920 int Foo() {\r
10921 if (isBar) {\r
10922 bar();\r
10923 return 1;\r
10924 } else\r
10925 return 0;\r
10926 }\r
10927 }\r
10928 </code>\r
10929 </item>\r
10930 <item>NAnt\r
10931 <code>\r
10932 namespace foospace {\r
10933 class foo() {\r
10934 #region Protected Static Fields\r
10935 private int Foo() {\r
10936 if (isBar) {\r
10937 bar();\r
10938 return 1;\r
10939 } else {\r
10940 return 0;\r
10941 }\r
10942 }\r
10943 #endregion\r
10944 }\r
10945 </code>\r
10946 </item>\r
10947 </list>\r
10948 </summary>\r
10949 </member>\r
10950 <member name="P:NAnt.Contrib.Tasks.Astyle.CleanUp">\r
10951 <summary>\r
10952 Astyle leaves the original files around, renamed with a different\r
10953 suffix. Setting this to <code>true</code>\r
10954 will remove these files.\r
10955 </summary>\r
10956 </member>\r
10957 <member name="P:NAnt.Contrib.Tasks.Astyle.Suffix">\r
10958 <summary>\r
10959 The suffix to append to original files, defaults to <c>.orig</c> \r
10960 if not specified.\r
10961 </summary>\r
10962 </member>\r
10963 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumSpaces">\r
10964 <summary>\r
10965 Indicate the maximum number of spaces to indent relative to a \r
10966 previous line.\r
10967 </summary>\r
10968 </member>\r
10969 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumTabs">\r
10970 <summary>\r
10971 Indicate that tabs should be used to indent sources. The number \r
10972 specified indicates the maximum number of spaces the tab character\r
10973 will represent.\r
10974 </summary>\r
10975 </member>\r
10976 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumTabsForce">\r
10977 <summary>\r
10978 Indent using tab characters. Treat each tab as # spaces. Uses tabs as \r
10979 indents in areas '--indent=tab' prefers to use spaces, such as \r
10980 inside multi-line statements.\r
10981 </summary>\r
10982 </member>\r
10983 <member name="P:NAnt.Contrib.Tasks.Astyle.ConvertTabs">\r
10984 <summary>\r
10985 <see langword="true" /> to convert tabs to spaces.\r
10986 </summary>\r
10987 </member>\r
10988 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentClass">\r
10989 <summary>\r
10990 <see langword="true" /> if class statements should be indented.\r
10991 <code>\r
10992 \r
10993 The default:\r
10995 class Foo\r
10996 {\r
10997 public:\r
10998 Foo();\r
10999 virtual ~Foo();\r
11000 };\r
11002 becomes:\r
11004 class Foo\r
11005 {\r
11006 public:\r
11007 Foo();\r
11008 virtual ~Foo();\r
11009 };\r
11010 \r
11011 </code>\r
11012 </summary>\r
11013 </member>\r
11014 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentSwitch">\r
11015 <summary>\r
11016 <see langword="true" /> if switch statements should be indented.\r
11017 <code>\r
11018 \r
11019 The default:\r
11021 switch (foo)\r
11022 {\r
11023 case 1:\r
11024 a += 2;\r
11025 break;\r
11027 default:\r
11028 a += 2;\r
11029 break;\r
11030 }\r
11032 becomes:\r
11034 switch (foo)\r
11035 {\r
11036 case 1:\r
11037 a += 2;\r
11038 break;\r
11040 default:\r
11041 a += 2;\r
11042 break;\r
11043 }\r
11044 \r
11045 </code>\r
11046 </summary>\r
11047 </member>\r
11048 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentCase">\r
11049 <summary>\r
11050 <see langword="true" /> if case statements should be indented.\r
11051 <code>\r
11052 \r
11053 The default:\r
11055 switch (foo)\r
11056 {\r
11057 case 1:\r
11058 {\r
11059 a += 2;\r
11060 break;\r
11061 }\r
11063 default:\r
11064 {\r
11065 a += 2;\r
11066 break;\r
11067 }\r
11068 }\r
11070 becomes:\r
11072 switch (foo)\r
11073 {\r
11074 case 1:\r
11075 {\r
11076 a += 2;\r
11077 break;\r
11078 }\r
11080 default:\r
11081 {\r
11082 a += 2;\r
11083 break;\r
11084 }\r
11085 }\r
11086 \r
11087 </code>\r
11088 </summary>\r
11089 </member>\r
11090 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentBracket">\r
11091 <summary>\r
11092 <code>true</code> if bracket statements should be indented.\r
11093 <code>\r
11094 \r
11095 The default:\r
11097 if (isFoo)\r
11098 {\r
11099 bar();\r
11100 }\r
11101 else\r
11102 {\r
11103 anotherBar();\r
11104 }\r
11106 becomes:\r
11108 if (isFoo)\r
11109 {\r
11110 bar();\r
11111 }\r
11112 else\r
11113 {\r
11114 anotherBar();\r
11115 }\r
11116 \r
11117 </code>\r
11118 </summary>\r
11119 </member>\r
11120 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentBlock">\r
11121 <summary>\r
11122 <see langword="true" /> if block statements should be indented.\r
11123 The default:\r
11125 if (isFoo)\r
11126 {\r
11127 bar();\r
11128 }\r
11129 else\r
11130 anotherBar();\r
11132 becomes:\r
11134 if (isFoo)\r
11135 {\r
11136 bar();\r
11137 }\r
11138 else\r
11139 anotherBar();\r
11140 </summary>\r
11141 </member>\r
11142 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNamespaces">\r
11143 <summary>\r
11144 <see langword="true" /> if namespace statements should be indented.\r
11145 <code>\r
11147 The default:\r
11149 namespace foospace\r
11150 {\r
11151 class Foo\r
11152 {\r
11153 public:\r
11154 Foo();\r
11155 virtual ~Foo();\r
11156 };\r
11157 }\r
11159 becomes:\r
11161 namespace foospace\r
11162 {\r
11163 class Foo\r
11164 {\r
11165 public:\r
11166 Foo();\r
11167 virtual ~Foo();\r
11168 };\r
11169 }\r
11171 </code>\r
11172 </summary>\r
11173 </member>\r
11174 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentLabels">\r
11175 <summary>\r
11176 <see langword="true" /> if label statements should be indented.\r
11177 <code>\r
11178 \r
11179 The default:\r
11181 int foospace()\r
11182 {\r
11183 while (isFoo)\r
11184 {\r
11185 ...\r
11186 goto error;\r
11188 error:\r
11189 ...\r
11190 }\r
11191 }\r
11193 becomes:\r
11195 int foospace()\r
11196 {\r
11197 while (isFoo)\r
11198 {\r
11199 ...\r
11200 goto error;\r
11202 error:\r
11203 ...\r
11204 }\r
11205 }\r
11207 </code>\r
11208 </summary>\r
11209 </member>\r
11210 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentMax">\r
11211 <summary>\r
11212 Indicate the maximum number of spaces to indent relative to a \r
11213 previous line.\r
11214 </summary>\r
11215 </member>\r
11216 <member name="P:NAnt.Contrib.Tasks.Astyle.IndentMin">\r
11217 <summary>\r
11218 Indicate the maximum number of spaces to indent relative to a \r
11219 previous line.\r
11220 </summary>\r
11221 </member>\r
11222 <member name="P:NAnt.Contrib.Tasks.Astyle.FillEmptyLines">\r
11223 <summary>\r
11224 <see langword="true" /> if empty lines should be filled with the \r
11225 whitespace of the previous line.\r
11226 </summary>\r
11227 </member>\r
11228 <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsNewLine">\r
11229 <summary>\r
11230 <see langword="true" /> if brackets should be put on a new line.\r
11231 <code>\r
11233 if (isFoo)\r
11234 {\r
11235 bar();\r
11236 }\r
11237 else\r
11238 {\r
11239 anotherBar();\r
11240 }\r
11241 \r
11242 </code>\r
11243 </summary>\r
11244 </member>\r
11245 <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsAttach">\r
11246 <summary>\r
11247 <see langword="true" /> if brackets should be attached.\r
11248 <code>\r
11249 \r
11250 if (isFoo){\r
11251 bar();\r
11252 } else {\r
11253 anotherBar();\r
11254 }\r
11255 \r
11256 </code>\r
11257 </summary>\r
11258 </member>\r
11259 <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsLinux">\r
11260 <summary>\r
11261 <see langword="true" /> if brackets should be put on a new line and \r
11262 indented.\r
11263 <code>\r
11265 namespace foospace\r
11266 {\r
11267 int Foo()\r
11268 {\r
11269 if (isBar) {\r
11270 bar();\r
11271 return 1;\r
11272 } else\r
11273 return 0;\r
11274 }\r
11275 }\r
11277 </code>\r
11278 </summary>\r
11279 </member>\r
11280 <member name="P:NAnt.Contrib.Tasks.Astyle.BreakClosing">\r
11281 <summary>\r
11282 <see langword="true" /> if the line after a bracket (i.e. an else \r
11283 statement after the closing if) should be placed on the next line.\r
11284 <code>\r
11285 \r
11286 if (isFoo){\r
11287 bar();\r
11288 }else {\r
11289 anotherBar();\r
11290 }\r
11292 becomes:\r
11294 if (isFoo) {\r
11295 bar();\r
11296 }\r
11297 else {\r
11298 anotherBar();\r
11299 }\r
11300 \r
11301 </code>\r
11302 </summary>\r
11303 </member>\r
11304 <member name="P:NAnt.Contrib.Tasks.Astyle.BreakBlocks">\r
11305 <summary>\r
11306 <see langword="true" /> to break block statements with an empty line.\r
11307 <code>\r
11309 isFoo = true;\r
11310 if (isFoo) {\r
11311 bar();\r
11312 } else {\r
11313 anotherBar();\r
11314 }\r
11315 isBar = false;\r
11317 becomes:\r
11319 isFoo = true;\r
11321 if (isFoo) {\r
11322 bar();\r
11323 } else {\r
11324 anotherBar();\r
11325 }\r
11327 isBar = false;\r
11329 </code>\r
11330 </summary>\r
11331 </member>\r
11332 <member name="P:NAnt.Contrib.Tasks.Astyle.BreakBlocksAll">\r
11333 <summary>\r
11334 <see langword="true" /> to break all block statements, even on \r
11335 nested ifs with an empty line.\r
11336 <code>\r
11338 isFoo = true;\r
11339 if (isFoo) {\r
11340 bar();\r
11341 } else {\r
11342 anotherBar();\r
11343 }\r
11344 isBar = false;\r
11346 becomes:\r
11348 isFoo = true;\r
11350 if (isFoo) {\r
11351 bar();\r
11353 } else {\r
11354 anotherBar();\r
11355 }\r
11357 isBar = false;\r
11359 </code>\r
11360 </summary>\r
11361 </member>\r
11362 <member name="P:NAnt.Contrib.Tasks.Astyle.BreakElseif">\r
11363 <summary>\r
11364 <see langword="true" /> to put the if component of an else if on a \r
11365 new line.\r
11366 <code>\r
11368 if (isFoo) {\r
11369 bar();\r
11370 } else if (isBar()){\r
11371 anotherBar();\r
11372 }\r
11374 becomes:\r
11376 if (isFoo) {\r
11377 bar();\r
11378 } else\r
11379 if (isBar()){\r
11380 anotherBar();\r
11381 } \r
11383 </code>\r
11384 \r
11385 </summary>\r
11386 </member>\r
11387 <member name="P:NAnt.Contrib.Tasks.Astyle.PadOperators">\r
11388 <summary>\r
11389 <see langword="true" /> to pad operators with a space.\r
11390 <code>\r
11391 \r
11392 if (isFoo)\r
11393 a = bar((b-c)*a,*d--);\r
11395 becomes:\r
11397 if (isFoo)\r
11398 a = bar((b - c) * a, *d--);\r
11400 </code>\r
11401 </summary>\r
11402 </member>\r
11403 <member name="P:NAnt.Contrib.Tasks.Astyle.PadParenthesis">\r
11404 <summary>\r
11405 <see langword="true" /> to pad parenthesis with a space.\r
11406 <code>\r
11408 if (isFoo)\r
11409 a = bar((b-c)*a,*d--);\r
11411 becomes:\r
11413 if ( isFoo )\r
11414 a = bar( ( b-c )*a, *d-- );\r
11416 </code>\r
11417 </summary>\r
11418 </member>\r
11419 <member name="P:NAnt.Contrib.Tasks.Astyle.PadAll">\r
11420 <summary>\r
11421 <see langword="true" /> to pad operators and parenthesis.\r
11422 <code>\r
11423 \r
11424 if (isFoo)\r
11425 a = bar((b-c)*a,*d--);\r
11427 becomes:\r
11429 if ( isFoo )\r
11430 a = bar( ( b - c ) * a, *d-- );\r
11432 </code>\r
11433 </summary>\r
11434 </member>\r
11435 <member name="P:NAnt.Contrib.Tasks.Astyle.NoBreakComplex">\r
11436 <summary>\r
11437 <see langword="true" /> to keep complex statements on the same line.\r
11438 <code>\r
11439 \r
11440 if (isFoo)\r
11441 { \r
11442 isFoo = false; cout << isFoo << endl;\r
11443 }\r
11445 remains as is.\r
11447 if (isFoo) DoBar();\r
11449 remains as is.\r
11451 </code>\r
11452 </summary>\r
11453 </member>\r
11454 <member name="P:NAnt.Contrib.Tasks.Astyle.NoBreakSingleLineBlocks">\r
11455 <summary>\r
11456 <see langword="true" /> to keep single line statements on the same line.\r
11457 <code>\r
11459 if (isFoo)\r
11460 { isFoo = false; cout << isFoo << endl; }\r
11462 remains as is.\r
11464 </code>\r
11465 </summary>\r
11466 </member>\r
11467 <member name="P:NAnt.Contrib.Tasks.Astyle.ProgramArguments">\r
11468 <summary>\r
11469 Gets the command-line arguments for the external program.\r
11470 </summary>\r
11471 <value>\r
11472 The command-line arguments for the external program.\r
11473 </value>\r
11474 </member>\r
11475 <member name="T:NAnt.Contrib.Tasks.COMRegisterTask">\r
11476 <summary>\r
11477 Register COM servers or type libraries.\r
11478 </summary>\r
11479 <remarks>\r
11480 <para>\r
11481 COM register task will try and register any type of COM related file \r
11482 that needs registering.\r
11483 </para>\r
11484 <para>Executable files (.exe) will be registered as exe servers, type \r
11485 libaries (.tlb) registered with RegisterTypeLib and for all other \r
11486 filetypes it will attempt to register them as dll servers.\r
11487 </para>\r
11488 </remarks>\r
11489 <example>\r
11490 <para>Register a single dll server.</para>\r
11491 <code>\r
11492 <![CDATA[\r
11493 <comregister file="myComServer.dll" />\r
11494 ]]>\r
11495 </code>\r
11496 </example>\r
11497 <example>\r
11498 <para>Register a single exe server </para>\r
11499 <code>\r
11500 <![CDATA[\r
11501 <comregister file="myComServer.exe" />\r
11502 ]]>\r
11503 </code>\r
11504 </example>\r
11505 <example>\r
11506 <para>Register a set of COM files at once.</para>\r
11507 <code>\r
11508 <![CDATA[\r
11509 <comregister unregister="false">\r
11510 <fileset>\r
11511 <include name="an_ExeServer.exe" />\r
11512 <include name="a_TypeLibrary.tlb" />\r
11513 <include name="a_DllServer.dll" />\r
11514 <include name="an_OcxServer.ocx" />\r
11515 </fileset>\r
11516 </comregister>\r
11517 ]]>\r
11518 </code>\r
11519 </example>\r
11520 </member>\r
11521 <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterDllServer(System.String)">\r
11522 <summary>\r
11523 Register an inproc COM server, usually a .dll or .ocx\r
11524 </summary>\r
11525 <param name="path"></param>\r
11526 </member>\r
11527 <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterTypelib(System.String)">\r
11528 <summary>\r
11529 Register a COM type library\r
11530 </summary>\r
11531 <param name="path"></param>\r
11532 </member>\r
11533 <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterExeServer(System.String)">\r
11534 <summary>\r
11535 Register exe servers.\r
11536 </summary>\r
11537 <param name="path"></param>\r
11538 </member>\r
11539 <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.File">\r
11540 <summary>\r
11541 The name of the file to register. This is provided as an alternate \r
11542 to using the task's fileset.\r
11543 </summary>\r
11544 </member>\r
11545 <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.Unregister">\r
11546 <summary>Unregistering this time. ( /u paramater )Default is "false".</summary>\r
11547 </member>\r
11548 <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.COMRegisterFileSet">\r
11549 <summary>\r
11550 The set of files to register.\r
11551 </summary>\r
11552 </member>\r
11553 <member name="T:NAnt.Contrib.Tasks.COMRegisterTask.DynamicPInvoke">\r
11554 <summary>\r
11555 Helper class to synamically build an assembly with the correct \r
11556 P/Invoke signature\r
11557 </summary>\r
11558 </member>\r
11559 <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.DynamicPInvoke.DynamicDllFuncInvoke(System.String,System.String)">\r
11560 <summary>\r
11561 Register a given dll.\r
11562 </summary>\r
11563 <param name="dll"></param>\r
11564 <param name="entrypoint"></param>\r
11565 <returns></returns>\r
11566 </member>\r
11567 <member name="T:NAnt.Contrib.Tasks.ChecksumTask">\r
11568 <summary>\r
11569 Calculates checksums for a set of files.\r
11570 Loosely based on Ant's Checksum task.\r
11571 </summary>\r
11572 <remarks>\r
11573 This task takes a set of input files in a fileset\r
11574 and calculates a checksum for each one of them. \r
11575 You can specify the algorithm to use when calculating\r
11576 the checksum value (MD5 or SHA1, for example).\r
11577 The calculated value is saved to a file with the same\r
11578 name as the input file and an added extension either\r
11579 based on the algorithm name (e.g. .MD5), or whatever \r
11580 is specified through the fileext attribute.\r
11581 </remarks>\r
11582 <example>\r
11583 <code>\r
11584 <![CDATA[\r
11585 <checksum algorithm="MD5" fileext="MD5">\r
11586 <fileset>\r
11587 <include name="${outputdir}\*.dll"/>\r
11588 </fileset>\r
11589 </checksum>\r
11590 ]]>\r
11591 </code>\r
11592 </example>\r
11593 </member>\r
11594 <member name="M:NAnt.Contrib.Tasks.ChecksumTask.InitializeTask(System.Xml.XmlNode)">\r
11595 <summary>\r
11596 Initializes task and ensures the supplied attributes are valid.\r
11597 </summary>\r
11598 <param name="taskNode">Xml node used to define this task instance.</param>\r
11599 </member>\r
11600 <member name="M:NAnt.Contrib.Tasks.ChecksumTask.ExecuteTask">\r
11601 <summary>\r
11602 This is where the work is done\r
11603 </summary>\r
11604 </member>\r
11605 <member name="M:NAnt.Contrib.Tasks.ChecksumTask.WriteChecksum(System.String,System.String)">\r
11606 <summary>\r
11607 Writes a checksum to a destination file\r
11608 </summary>\r
11609 <param name="filename"></param>\r
11610 <param name="checksum"></param>\r
11611 </member>\r
11612 <member name="P:NAnt.Contrib.Tasks.ChecksumTask.Algorithm">\r
11613 <summary>\r
11614 Name of Algorithm to use when calculating\r
11615 the checksum. Can be MD5 or SHA1.\r
11616 </summary>\r
11617 </member>\r
11618 <member name="P:NAnt.Contrib.Tasks.ChecksumTask.FileExtension">\r
11619 <summary>\r
11620 The generated checksum file's name will be the \r
11621 original filename with "." and fileext \r
11622 added to it. Defaults to the \r
11623 algorithm name being used\r
11624 </summary>\r
11625 </member>\r
11626 <member name="P:NAnt.Contrib.Tasks.ChecksumTask.FileSet">\r
11627 <summary>\r
11628 Set of files to use as input\r
11629 </summary>\r
11630 </member>\r
11631 <member name="T:NAnt.Contrib.Tasks.CodeStatsTask">\r
11632 <summary>\r
11633 Generates statistics from source code.\r
11634 </summary>\r
11635 <remarks>\r
11636 Scans files in a fileset counting lines.\r
11637 </remarks>\r
11638 <example>\r
11639 <para>\r
11640 Generate statistics for a set of C# and VB.NET sources, applying \r
11641 different labels for both.\r
11642 </para>\r
11643 <code>\r
11644 <![CDATA[\r
11645 <codestats output="test.xml" append="true" buildname="MyBuildName">\r
11646 <counts>\r
11647 <count label="C#">\r
11648 <fileset>\r
11649 <include name="**/*.cs" />\r
11650 </fileset>\r
11651 </count>\r
11652 <count label="VB">\r
11653 <fileset>\r
11654 <include name="**\*.vb" />\r
11655 </fileset>\r
11656 </count>\r
11657 </counts>\r
11658 </codestats>\r
11659 ]]>\r
11660 </code>\r
11661 </example>\r
11662 <example>\r
11663 <para>\r
11664 Generate statistics for all C# sources and only output a summary to \r
11665 the log.\r
11666 </para>\r
11667 <code>\r
11668 <![CDATA[\r
11669 <codestats output="test.xml" verbose="true" summarize="true">\r
11670 <counts>\r
11671 <count label="C#">\r
11672 <fileset>\r
11673 <include name="**\*.cs" />\r
11674 </fileset>\r
11675 </count>\r
11676 </counts>\r
11677 </codestats>\r
11678 ]]>\r
11679 </code>\r
11680 </example>\r
11681 </member>\r
11682 <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.CodeStats">\r
11683 <summary>\r
11684 Set of line counters to enable. \r
11685 </summary>\r
11686 </member>\r
11687 <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.BuildName">\r
11688 <summary>\r
11689 An identifier to be able to track which build last updated the \r
11690 code stats file.\r
11691 </summary>\r
11692 </member>\r
11693 <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.AppendFile">\r
11694 <summary>\r
11695 Specifies whether the results should be appended to the output file.\r
11696 The default is <see langword="false" />.\r
11697 </summary>\r
11698 </member>\r
11699 <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.Summarize">\r
11700 <summary>\r
11701 If you only want to show summary stats for the whole fileset\r
11702 </summary>\r
11703 </member>\r
11704 <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.OutputFile">\r
11705 <summary>\r
11706 The name of the file to save the output to (in XML).\r
11707 </summary>\r
11708 </member>\r
11709 <member name="T:NAnt.Contrib.Tasks.ConcatTask">\r
11710 <summary>\r
11711 A task that concatenates a set of files.\r
11712 Loosely based on Ant's Concat task.\r
11713 </summary>\r
11714 <remarks>\r
11715 <para>\r
11716 This task takes a set of input files in a fileset\r
11717 and concatenates them into a single file. You can \r
11718 either replace the output file, or append to it \r
11719 by using the append attribute.\r
11720 </para>\r
11721 <para>\r
11722 The order the files are concatenated in is not\r
11723 especified.\r
11724 </para>\r
11725 </remarks>\r
11726 <example>\r
11727 <code>\r
11728 <![CDATA[\r
11729 <concat destfile="${outputdir}\Full.txt" append="true">\r
11730 <fileset>\r
11731 <include name="${outputdir}\Test-*.txt" />\r
11732 </fileset>\r
11733 </concat>\r
11734 ]]>\r
11735 </code>\r
11736 </example>\r
11737 </member>\r
11738 <member name="M:NAnt.Contrib.Tasks.ConcatTask.InitializeTask(System.Xml.XmlNode)">\r
11739 <summary>\r
11740 Initializes task and ensures the supplied attributes are valid.\r
11741 </summary>\r
11742 <param name="taskNode">Xml node used to define this task instance.</param>\r
11743 </member>\r
11744 <member name="M:NAnt.Contrib.Tasks.ConcatTask.ExecuteTask">\r
11745 <summary>\r
11746 This is where the work is done\r
11747 </summary>\r
11748 </member>\r
11749 <member name="M:NAnt.Contrib.Tasks.ConcatTask.OpenDestinationFile">\r
11750 <summary>\r
11751 Opens the destination file according\r
11752 to the specified flags\r
11753 </summary>\r
11754 <returns></returns>\r
11755 </member>\r
11756 <member name="M:NAnt.Contrib.Tasks.ConcatTask.AppendFiles(System.IO.FileStream)">\r
11757 <summary>\r
11758 Appends all specified files\r
11759 </summary>\r
11760 <param name="output">File to write to</param>\r
11761 </member>\r
11762 <member name="P:NAnt.Contrib.Tasks.ConcatTask.DestinationFile">\r
11763 <summary>\r
11764 Name of the destination file.\r
11765 </summary>\r
11766 </member>\r
11767 <member name="P:NAnt.Contrib.Tasks.ConcatTask.Append">\r
11768 <summary>\r
11769 Specifies whether to append to the destination file.\r
11770 The default is <see langword="false" />.\r
11771 </summary>\r
11772 </member>\r
11773 <member name="P:NAnt.Contrib.Tasks.ConcatTask.FileSet">\r
11774 <summary>\r
11775 Set of files to use as input.\r
11776 </summary>\r
11777 </member>\r
11778 <member name="T:NAnt.Contrib.Tasks.DependsTask">\r
11779 <summary>\r
11780 On execution guarantees the listed dependencies are resolved before continuing. It is \r
11781 particularly useful for handling dynamic dependencies that change based on some input \r
11782 conditions/parameters, or when the dependencies are not known until runtime.\r
11783 </summary>\r
11784 <remarks>The depends task never forces the execution of any target that has already been executed. It works just like the depends attribute of a <see cref="T:NAnt.Core.Target"/>.</remarks>\r
11785 </member>\r
11786 <member name="M:NAnt.Contrib.Tasks.DependsTask.ExecuteTask">\r
11787 <summary>\r
11788 Executes the specified task.\r
11789 </summary>\r
11790 </member>\r
11791 <member name="P:NAnt.Contrib.Tasks.DependsTask.DependsCollection">\r
11792 <summary>\r
11793 A space or comma separated dependency list of targets. \r
11794 </summary>\r
11795 <remarks>\r
11796 Expressions get evaluated when the task is executed. \r
11797 </remarks>\r
11798 </member>\r
11799 <member name="T:NAnt.Contrib.Tasks.DicsoTask">\r
11800 <summary>\r
11801 Discovers the URLs of XML web services on a web server and saves documents\r
11802 related to them to the local disk. The resulting .discomap, .wsdl, and .xsd files\r
11803 can be used with the <see cref="T:NAnt.Contrib.Tasks.WsdlTask"/> to produce web service clients and\r
11804 and abstract web service servers using ASP.NET.\r
11805 </summary>\r
11806 <example>\r
11807 <para>Generate a proxy class for a web service.</para>\r
11808 <code>\r
11809 <![CDATA[\r
11810 <disco \r
11811 path="http://www.somewhere.com/myservice.wsdl"\r
11812 language="CS" \r
11813 namespace="MyCompany.MyService" \r
11814 outfile="MyService.cs" \r
11815 />\r
11816 ]]>\r
11817 </code>\r
11818 </example>\r
11819 </member>\r
11820 <member name="M:NAnt.Contrib.Tasks.DicsoTask.ExecuteTask">\r
11821 <summary>\r
11822 Discover the details for the specified web service.\r
11823 </summary>\r
11824 </member>\r
11825 <member name="P:NAnt.Contrib.Tasks.DicsoTask.Path">\r
11826 <summary>The URL or Path to discover.</summary>\r
11827 </member>\r
11828 <member name="P:NAnt.Contrib.Tasks.DicsoTask.NoLogo">\r
11829 <summary>Suppresses the banner.</summary>\r
11830 </member>\r
11831 <member name="P:NAnt.Contrib.Tasks.DicsoTask.NoSave">\r
11832 <summary>Do not save the discovered documents to the local disk.</summary>\r
11833 </member>\r
11834 <member name="P:NAnt.Contrib.Tasks.DicsoTask.OutputDir">\r
11835 <summary>The output directory to save discovered documents in.</summary>\r
11836 </member>\r
11837 <member name="P:NAnt.Contrib.Tasks.DicsoTask.Username">\r
11838 <summary>Username of an account with credentials to access a\r
11839 server that requires authentication.</summary>\r
11840 </member>\r
11841 <member name="P:NAnt.Contrib.Tasks.DicsoTask.Password">\r
11842 <summary>Password of an account with credentials to access a\r
11843 server that requires authentication.</summary>\r
11844 </member>\r
11845 <member name="P:NAnt.Contrib.Tasks.DicsoTask.Domain">\r
11846 <summary>Domain of an account with credentials to access a\r
11847 server that requires authentication.</summary>\r
11848 </member>\r
11849 <member name="P:NAnt.Contrib.Tasks.DicsoTask.Proxy">\r
11850 <summary>URL of a proxy server to use for HTTP requests.\r
11851 The default is to use the system proxy setting.</summary>\r
11852 </member>\r
11853 <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyUsername">\r
11854 <summary>Username of an account with credentials to access a\r
11855 proxy that requires authentication.</summary>\r
11856 </member>\r
11857 <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyPassword">\r
11858 <summary>Password of an account with credentials to access a\r
11859 proxy that requires authentication.</summary>\r
11860 </member>\r
11861 <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyDomain">\r
11862 <summary>Domain of an account with credentials to access a\r
11863 proxy that requires authentication.</summary>\r
11864 </member>\r
11865 <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProgramArguments">\r
11866 <summary>\r
11867 Gets the command-line arguments for the external program.\r
11868 </summary>\r
11869 <value>\r
11870 The command-line arguments for the external program.\r
11871 </value>\r
11872 </member>\r
11873 <member name="T:NAnt.Contrib.Tasks.FxCopTask">\r
11874 <summary>\r
11875 Analyzes managed code assemblies and reports information about the \r
11876 assemblies, such as possible design, localization, performance, and \r
11877 security improvements.\r
11878 </summary>\r
11879 <remarks>\r
11880 <note>\r
11881 this task relies on fxcopcmd.exe being in your PATH environment variable. \r
11882 You can download the latest FxCop from <see href="http://www.gotdotnet.com/team/fxcop/" />.\r
11883 </note>\r
11884 </remarks>\r
11885 <example>\r
11886 <code>\r
11887 <![CDATA[\r
11888 <fxcop directOutputToConsole="true" projectFile="${build.dir}\Sample.fxcop">\r
11889 <targets>\r
11890 <include name="${build.dir}\bin\*.dll" />\r
11891 </targets>\r
11892 <rules>\r
11893 <include name="${build.dir}\rules\*.dll" />\r
11894 </rules>\r
11895 </fxcop>\r
11896 ]]>\r
11897 </code>\r
11898 </example>\r
11899 </member>\r
11900 <member name="M:NAnt.Contrib.Tasks.FxCopTask.#ctor">\r
11901 <summary>\r
11902 Creates a new <see cref="T:NAnt.Contrib.Tasks.FxCopTask"/> instance.\r
11903 </summary>\r
11904 </member>\r
11905 <member name="M:NAnt.Contrib.Tasks.FxCopTask.PrepareProcess(System.Diagnostics.Process)">\r
11906 <summary>\r
11907 Performs logic before the external process is started\r
11908 </summary>\r
11909 <param name="process">Process.</param>\r
11910 </member>\r
11911 <member name="M:NAnt.Contrib.Tasks.FxCopTask.BuildArguments">\r
11912 <summary>\r
11913 Builds the arguments to pass to the exe.\r
11914 </summary>\r
11915 </member>\r
11916 <member name="P:NAnt.Contrib.Tasks.FxCopTask.ApplyOutXsl">\r
11917 <summary>\r
11918 Applies the XSL transformation specified in /outXsl to the analysis report before saving the file.\r
11919 </summary>\r
11920 </member>\r
11921 <member name="P:NAnt.Contrib.Tasks.FxCopTask.DirectOutputToConsole">\r
11922 <summary>\r
11923 Directs analysis output to the console or to the Output window in Visual Studio .NET. By default, the XSL file FxCopConsoleOutput.xsl is applied to the output before it is displayed.\r
11924 </summary>\r
11925 </member>\r
11926 <member name="P:NAnt.Contrib.Tasks.FxCopTask.ConsoleXslFilename">\r
11927 <summary>\r
11928 Specifies the XSL or XSLT file that contains a transformation to be applied to the analysis output before it is displayed in the console.\r
11929 </summary>\r
11930 </member>\r
11931 <member name="P:NAnt.Contrib.Tasks.FxCopTask.DependencyDirectories">\r
11932 <summary>\r
11933 Specifies additional directories to search for assembly dependencies. FxCopCmd always searches the target assembly directory and the current working directory.\r
11934 </summary>\r
11935 </member>\r
11936 <member name="P:NAnt.Contrib.Tasks.FxCopTask.TargetAssemblies">\r
11937 <summary>\r
11938 Specifies the target assembly to analyze.\r
11939 </summary>\r
11940 </member>\r
11941 <member name="P:NAnt.Contrib.Tasks.FxCopTask.ImportFiles">\r
11942 <summary>\r
11943 Specifies the name of an analysis report or project file to import. Any messages in the imported file that are marked as excluded are not included in the analysis results.\r
11944 </summary>\r
11945 </member>\r
11946 <member name="P:NAnt.Contrib.Tasks.FxCopTask.AnalysisReportFilename">\r
11947 <summary>\r
11948 Specifies the file name for the analysis report.\r
11949 </summary>\r
11950 </member>\r
11951 <member name="P:NAnt.Contrib.Tasks.FxCopTask.OutputXslFilename">\r
11952 <summary>\r
11953 Specifies the XSL or XSLT file that is referenced by the xml-stylesheet processing instruction in the analysis report.\r
11954 </summary>\r
11955 </member>\r
11956 <member name="P:NAnt.Contrib.Tasks.FxCopTask.PlatformDirectory">\r
11957 <summary>\r
11958 Specifies the location of the version of Mscorlib.dll that was used when building the target assemblies if this version is not installed on the computer running FxCopCmd.\r
11959 </summary>\r
11960 </member>\r
11961 <member name="P:NAnt.Contrib.Tasks.FxCopTask.ProjectFile">\r
11962 <summary>\r
11963 Specifies the filename of FxCop project file.\r
11964 </summary>\r
11965 </member>\r
11966 <member name="P:NAnt.Contrib.Tasks.FxCopTask.RuleLibraries">\r
11967 <summary>\r
11968 Specifies the filename(s) of FxCop project file(s).\r
11969 </summary>\r
11970 </member>\r
11971 <member name="P:NAnt.Contrib.Tasks.FxCopTask.IncludeSummaryReport">\r
11972 <summary>\r
11973 Includes a summary report with the informational messages returned by FxCopCmd.\r
11974 </summary>\r
11975 </member>\r
11976 <member name="P:NAnt.Contrib.Tasks.FxCopTask.TypeList">\r
11977 <summary>\r
11978 Comma-separated list of type names to analyze. This option disables analysis of assemblies, namespaces, and resources; only the specified types and their members are included in the analysis. \r
11979 Use the wildcard character '*' at the end of the name to select multiple types.\r
11980 </summary>\r
11981 </member>\r
11982 <member name="P:NAnt.Contrib.Tasks.FxCopTask.SaveResults">\r
11983 <summary>\r
11984 Saves the results of the analysis in the project file.\r
11985 </summary>\r
11986 </member>\r
11987 <member name="P:NAnt.Contrib.Tasks.FxCopTask.ProgramArguments">\r
11988 <summary>\r
11989 Gets the program arguments.\r
11990 </summary>\r
11991 </member>\r
11992 <member name="T:NAnt.Contrib.Tasks.GacInstallTask">\r
11993 <summary>\r
11994 Installs assemblies into the Global Assembly Cache (GAC) by using the <c>gacutil</c> SDK tool.\r
11995 </summary>\r
11996 <remarks>\r
11997 <para>\r
11998 Assemblies can be installed to the GAC with or without reference counting. The full details of reference counting can be found in\r
11999 the SDK documentation.\r
12000 </para>\r
12001 </remarks>\r
12002 <example>\r
12003 <para>Installs <c>Shared.dll</c> into the GAC.</para>\r
12004 <code>\r
12005 <![CDATA[\r
12006 <gac-install>\r
12007 <assemblies>\r
12008 <include name="Shared.dll" />\r
12009 </assemblies>\r
12010 </gac-install>\r
12011 ]]>\r
12012 </code>\r
12013 </example>\r
12014 <example>\r
12015 <para>\r
12016 Installs <c>Shared.dll</c> and <c>MyWeb.dll</c> into the GAC.\r
12017 </para>\r
12018 <code>\r
12019 <![CDATA[\r
12020 <gac-install>\r
12021 <assemblies>\r
12022 <include name="Shared.dll" />\r
12023 <include name="MyWeb.dll" />\r
12024 </assemblies>\r
12025 </gac-install>\r
12026 ]]>\r
12027 </code>\r
12028 </example>\r
12029 <example>\r
12030 <para>\r
12031 Installs <c>Shared.dll</c> and <c>MyWeb.dll</c> into the GAC and \r
12032 specifies reference information.\r
12033 </para>\r
12034 <code>\r
12035 <![CDATA[\r
12036 <gac-install scheme-type="Opaque" scheme-id="MyID" scheme-description="My description">\r
12037 <assemblies>\r
12038 <include name="Shared.dll" />\r
12039 <include name="MyWeb.dll" />\r
12040 </assemblies>\r
12041 </gacinstall>\r
12042 ]]>\r
12043 </code>\r
12044 </example>\r
12045 </member>\r
12046 <member name="T:NAnt.Contrib.Tasks.GacTaskBase">\r
12047 <summary>\r
12048 Base class functionality for the GAC tasks.\r
12049 </summary>\r
12050 <remarks>\r
12051 Concrete GAC tasks extend this class in order to obtain common functionality.\r
12052 </remarks>\r
12053 </member>\r
12054 <member name="F:NAnt.Contrib.Tasks.GacTaskBase._currentAssembly">\r
12055 <summary>\r
12056 Stores the details of the assembly currently being operated against. This could be a name or\r
12057 path, depending on the concrete task.\r
12058 </summary>\r
12059 </member>\r
12060 <member name="F:NAnt.Contrib.Tasks.GacTaskBase._force">\r
12061 <summary>\r
12062 See <see cref="P:NAnt.Contrib.Tasks.GacTaskBase.Force"/>.\r
12063 </summary>\r
12064 </member>\r
12065 <member name="F:NAnt.Contrib.Tasks.GacTaskBase._reference">\r
12066 <summary>\r
12067 See <see cref="P:NAnt.Contrib.Tasks.GacTaskBase.Reference"/>.\r
12068 </summary>\r
12069 </member>\r
12070 <member name="M:NAnt.Contrib.Tasks.GacTaskBase.#ctor">\r
12071 <summary>\r
12072 Constructs and initialises an instance of <c>GacTask</c>.\r
12073 </summary>\r
12074 </member>\r
12075 <member name="M:NAnt.Contrib.Tasks.GacTaskBase.StartProcess">\r
12076 <summary>\r
12077 Starts the process that is wrapped by this GAC task.\r
12078 </summary>\r
12079 <remarks>\r
12080 Provided only to seal the implementation of <c>StartProcess()</c>.\r
12081 </remarks>\r
12082 <returns>The process that was started.</returns>\r
12083 </member>\r
12084 <member name="M:NAnt.Contrib.Tasks.GacTaskBase.InitializeTask(System.Xml.XmlNode)">\r
12085 <summary>\r
12086 Validates the task's configuration.\r
12087 </summary>\r
12088 <param name="taskNode">The task node.</param>\r
12089 </member>\r
12090 <member name="M:NAnt.Contrib.Tasks.GacTaskBase.ExecuteTask">\r
12091 <summary>\r
12092 Executes the task.\r
12093 </summary>\r
12094 <remarks>\r
12095 Provided only to seal the implementation of <c>ExecuteTask()</c>.\r
12096 </remarks>\r
12097 </member>\r
12098 <member name="M:NAnt.Contrib.Tasks.GacTaskBase.AppendProgramArguments(System.Text.StringBuilder)">\r
12099 <summary>\r
12100 Appends any task-specific program arguments.\r
12101 </summary>\r
12102 <param name="sb">The <c>StringBuilder</c> on which to append program arguments.</param>\r
12103 <remarks>\r
12104 Subclasses must override this method to return the arguments with which to run the GAC task.\r
12105 </remarks>\r
12106 </member>\r
12107 <member name="M:NAnt.Contrib.Tasks.GacTaskBase.BeforeExecuteTask">\r
12108 <summary>\r
12109 Invoked prior to invoking <c>ExecuteTask()</c> on the base class.\r
12110 </summary>\r
12111 <remarks>\r
12112 Allows, for example, subclasses to output useful information to the log.\r
12113 </remarks>\r
12114 </member>\r
12115 <member name="P:NAnt.Contrib.Tasks.GacTaskBase.Force">\r
12116 <summary>\r
12117 Gets or sets a value indicating whether the GAC operation will be forced.\r
12118 </summary>\r
12119 <remarks>\r
12120 The exact meaning of this property is dependent on the subclass. As such, subclasses should override this\r
12121 property to provide a valid description.\r
12122 </remarks>\r
12123 </member>\r
12124 <member name="P:NAnt.Contrib.Tasks.GacTaskBase.Reference">\r
12125 <summary>\r
12126 Specifies reference details to use when working with the GAC.\r
12127 </summary>\r
12128 </member>\r
12129 <member name="P:NAnt.Contrib.Tasks.GacTaskBase.AssemblyList">\r
12130 <summary>\r
12131 Concrete GAC tasks must override this property to return an array of assembly names or paths\r
12132 upon which to operate.\r
12133 </summary>\r
12134 </member>\r
12135 <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ExeName">\r
12136 <summary>\r
12137 Gets the executable name for the <c>gacutil</c> command-line tool.\r
12138 </summary>\r
12139 </member>\r
12140 <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ReferenceSpecified">\r
12141 <summary>\r
12142 Specifies whether a reference was specified for the GAC task.\r
12143 </summary>\r
12144 </member>\r
12145 <member name="P:NAnt.Contrib.Tasks.GacTaskBase.CurrentAssembly">\r
12146 <summary>\r
12147 Gets the current assembly being operated against.\r
12148 </summary>\r
12149 </member>\r
12150 <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ProgramArguments">\r
12151 <summary>\r
12152 Gets the program arguments with which to run the <c>gacutil</c> process.\r
12153 </summary>\r
12154 </member>\r
12155 <member name="F:NAnt.Contrib.Tasks.GacInstallTask._assemblies">\r
12156 <summary>\r
12157 See <see cref="P:NAnt.Contrib.Tasks.GacInstallTask.Assemblies"/>.\r
12158 </summary>\r
12159 </member>\r
12160 <member name="M:NAnt.Contrib.Tasks.GacInstallTask.#ctor">\r
12161 <summary>\r
12162 Constructs and initialises an instance of the <c>GacInstallTask</c>.\r
12163 </summary>\r
12164 </member>\r
12165 <member name="M:NAnt.Contrib.Tasks.GacInstallTask.AppendProgramArguments(System.Text.StringBuilder)">\r
12166 <summary>\r
12167 Appends any install-specific arguments.\r
12168 </summary>\r
12169 <param name="sb">The <c>StringBuilder</c> to append arguments to.</param>\r
12170 </member>\r
12171 <member name="M:NAnt.Contrib.Tasks.GacInstallTask.BeforeExecuteTask">\r
12172 <summary>\r
12173 Outputs log information.\r
12174 </summary>\r
12175 </member>\r
12176 <member name="P:NAnt.Contrib.Tasks.GacInstallTask.Assemblies">\r
12177 <summary>\r
12178 Specifies the assemblies to install.\r
12179 </summary>\r
12180 </member>\r
12181 <member name="P:NAnt.Contrib.Tasks.GacInstallTask.AssemblyList">\r
12182 <summary>\r
12183 Gets the assembly list to install.\r
12184 </summary>\r
12185 </member>\r
12186 <member name="P:NAnt.Contrib.Tasks.GacInstallTask.Force">\r
12187 <summary>\r
12188 If <see langword="true" />, the specified assemblies will be forcibly \r
12189 installed. Any existing duplicate assemblies in the GAC will be \r
12190 overwritten. The default is <see langword="false" />.\r
12191 </summary>\r
12192 </member>\r
12193 <member name="T:NAnt.Contrib.Tasks.GacTask">\r
12194 <summary>\r
12195 Manipulates the contents of the global assembly cache.\r
12196 </summary>\r
12197 <remarks>\r
12198 <para>\r
12199 This tasks provides some of the same functionality as the gacutil tool \r
12200 provided in the .NET Framework SDK.\r
12201 </para>\r
12202 <para>\r
12203 Specifically, the <see cref="T:NAnt.Contrib.Tasks.GacTask"/> allows you to install assemblies \r
12204 into the cache and remove them from the cache.\r
12205 </para>\r
12206 <para>\r
12207 Refer to the <see href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrfglobalassemblycacheutilitygacutilexe.htm">\r
12208 Global Assembly Cache Tool (Gacutil.exe)</see> for more information.\r
12209 </para>\r
12210 </remarks>\r
12211 <example>\r
12212 <para>\r
12213 Inserts assembly <c>mydll.dll</c> into the global assembly cache.\r
12214 </para>\r
12215 <code>\r
12216 <![CDATA[\r
12217 <gac assembly="mydll.dll" action="install" />\r
12218 ]]>\r
12219 </code>\r
12220 </example>\r
12221 <example>\r
12222 <para>\r
12223 Removes the assembly <c>hello</c> from the global assembly cache and \r
12224 the native image cache.\r
12225 </para>\r
12226 <code>\r
12227 <![CDATA[\r
12228 <gac assembly="hello" action="uninstall" />\r
12229 ]]>\r
12230 </code>\r
12231 <para>\r
12232 Note that the previous command might remove more than one assembly \r
12233 from the assembly cache because the assembly name is not fully \r
12234 specified. For example, if both version 1.0.0.0 and 3.2.2.1 of \r
12235 <c>hello</c> are installed in the cache, both of the assemblies will \r
12236 be removed from the global assembly cache.\r
12237 </para>\r
12238 </example>\r
12239 <example>\r
12240 <para>\r
12241 Use the following example to avoid removing more than one assembly. \r
12242 This command removes only the hello assembly that matches the fully \r
12243 specified version number, culture, and public key.\r
12244 </para>\r
12245 <code>\r
12246 <![CDATA[\r
12247 <gac assembly="hello,Version=1.0.0.1,Culture=de,PublicKeyToken=45e343aae32233ca" action="uninstall" />\r
12248 ]]>\r
12249 </code>\r
12250 </example>\r
12251 </member>\r
12252 <member name="P:NAnt.Contrib.Tasks.GacTask.AssemblyName">\r
12253 <summary>\r
12254 The name of a file that contains an assembly manifest.\r
12255 </summary>\r
12256 </member>\r
12257 <member name="P:NAnt.Contrib.Tasks.GacTask.ActionType">\r
12258 <summary>\r
12259 Defines the action to take with the assembly. The default is \r
12260 <see cref="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.install"/>.\r
12261 </summary>\r
12262 </member>\r
12263 <member name="P:NAnt.Contrib.Tasks.GacTask.AssemblyFileSet">\r
12264 <summary>\r
12265 Fileset are used to define multiple assemblies.\r
12266 </summary>\r
12267 </member>\r
12268 <member name="T:NAnt.Contrib.Tasks.GacTask.ActionTypes">\r
12269 <summary>\r
12270 Defines the actions that can be performed on an assembly using the\r
12271 <see cref="T:NAnt.Contrib.Tasks.GacTask"/>.\r
12272 </summary>\r
12273 </member>\r
12274 <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.install">\r
12275 <summary>\r
12276 Installs an assembly into the global assembly cache.\r
12277 </summary>\r
12278 </member>\r
12279 <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.overwrite">\r
12280 <summary>\r
12281 Installs an assembly into the global assembly cache. If an assembly \r
12282 with the same name already exists in the global assembly cache, it is \r
12283 overwritten.\r
12284 </summary>\r
12285 </member>\r
12286 <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.uninstall">\r
12287 <summary>\r
12288 Uninstalls an assembly from the global assembly cache.\r
12289 </summary>\r
12290 </member>\r
12291 <member name="T:NAnt.Contrib.Tasks.GacUninstallTask">\r
12292 <summary>\r
12293 Uninstalls assemblies from the Global Assembly Cache (GAC) by using the <c>gacutil</c> SDK tool.\r
12294 </summary>\r
12295 <remarks>\r
12296 <para>\r
12297 Assemblies are specified via an <see cref="T:NAnt.Contrib.Types.AssemblySet"/>. Individual assemblies are specified by their identity information. Only a\r
12298 name is required but, optionally, the assembly version, culture and public key token may be specified.\r
12299 </para>\r
12300 <para>\r
12301 Assemblies can be uninstalled from the GAC with or without reference counting. The full details of reference counting can be found in\r
12302 the SDK documentation.\r
12303 </para>\r
12304 </remarks>\r
12305 <example>\r
12306 <para>Uninstalls <c>Shared</c> assembly from the GAC.</para>\r
12307 <code>\r
12308 <![CDATA[\r
12309 <gac-uninstall>\r
12310 <assemblies>\r
12311 <assembly name="Shared" />\r
12312 </assemblies>\r
12313 </gac-uninstall>\r
12314 ]]>\r
12315 </code>\r
12316 </example>\r
12317 <example>\r
12318 <para>\r
12319 Uninstalls <c>Shared</c> and <c>MyWeb</c> from the GAC.\r
12320 </para>\r
12321 <code>\r
12322 <![CDATA[\r
12323 <gac-uninstall>\r
12324 <assemblies>\r
12325 <assembly name="Shared" />\r
12326 <assembly name="MyWeb" />\r
12327 </assemblies>\r
12328 </gac-uninstall>\r
12329 ]]>\r
12330 </code>\r
12331 </example>\r
12332 <example>\r
12333 <para>\r
12334 Decrements references to <c>Shared</c> in the GAC and uninstalls if \r
12335 the reference count reaches zero.\r
12336 </para>\r
12337 <code>\r
12338 <![CDATA[\r
12339 <gac-uninstall scheme-type="Opaque" scheme-id="MyID" scheme-description="My description">\r
12340 <assemblies>\r
12341 <assembly name="Shared" />\r
12342 </assemblies>\r
12343 </gac-uninstall>\r
12344 ]]>\r
12345 </code>\r
12346 </example>\r
12347 <example>\r
12348 <para>\r
12349 Uninstalls version <c>2.1.7.9201</c> of <c>Shared</c> plus the \r
12350 Australian-cultured <c>MyWeb</c> from the GAC.\r
12351 </para>\r
12352 <code>\r
12353 <![CDATA[\r
12354 <gac-uninstall>\r
12355 <assemblies>\r
12356 <assembly name="Shared" version="2.1.7.9201" />\r
12357 <assembly name="MyWeb" culture="en-AU" />\r
12358 </assemblies>\r
12359 </gac-uninstall>\r
12360 ]]>\r
12361 </code>\r
12362 </example>\r
12363 <example>\r
12364 <para>\r
12365 Uninstalls the neutrally-cultured, version <c>1.0.5000.0</c> of \r
12366 <c>System.Xml</c> from the native image cache. The assembly must\r
12367 also have a public key token of <c>b77a5c561934e08a</c> to be \r
12368 uninstalled.\r
12369 </para>\r
12370 <code>\r
12371 <![CDATA[\r
12372 <gac-uninstall native="true">\r
12373 <assemblies>\r
12374 <assembly name="System.Xml" version="1.0.5000.0" public-key-token="b77a5c561934e08a" culture="Neutral" />\r
12375 </assemblies>\r
12376 </gac-uninstall>\r
12377 ]]>\r
12378 </code>\r
12379 </example>\r
12380 </member>\r
12381 <member name="F:NAnt.Contrib.Tasks.GacUninstallTask._native">\r
12382 <summary>\r
12383 See <see cref="P:NAnt.Contrib.Tasks.GacUninstallTask.Native"/>.\r
12384 </summary>\r
12385 </member>\r
12386 <member name="F:NAnt.Contrib.Tasks.GacUninstallTask._assemblies">\r
12387 <summary>\r
12388 See <see cref="P:NAnt.Contrib.Tasks.GacUninstallTask.Assemblies"/>.\r
12389 </summary>\r
12390 </member>\r
12391 <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.#ctor">\r
12392 <summary>\r
12393 Constructs an instance of the <c>GacUninstallTask</c>.\r
12394 </summary>\r
12395 </member>\r
12396 <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.AppendProgramArguments(System.Text.StringBuilder)">\r
12397 <summary>\r
12398 Appends any install-specific arguments.\r
12399 </summary>\r
12400 <param name="sb"></param>\r
12401 </member>\r
12402 <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.BeforeExecuteTask">\r
12403 <summary>\r
12404 Outputs log information.\r
12405 </summary>\r
12406 </member>\r
12407 <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Native">\r
12408 <summary>\r
12409 If <see langword="true" />, specifies that the assemblies should be \r
12410 uninstalled from the native image cache. The default is <see langword="false" />.\r
12411 </summary>\r
12412 </member>\r
12413 <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Assemblies">\r
12414 <summary>\r
12415 Specifies the assemblies to uninstall.\r
12416 </summary>\r
12417 </member>\r
12418 <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.AssemblyList">\r
12419 <summary>\r
12420 Gets the assembly list to uninstall.\r
12421 </summary>\r
12422 </member>\r
12423 <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Force">\r
12424 <summary>\r
12425 If <see langword="true" />, the specified assemblies will be forcibly \r
12426 removed from the GAC. All references to the specified assemblies will\r
12427 be removed from the GAC prior to removing the assemblies themselves. \r
12428 The default is <see langword="false" />.\r
12429 </summary>\r
12430 <remarks>\r
12431 You cannot use this option to remove an assembly that was installed using Microsoft Windows Installer.\r
12432 </remarks>\r
12433 </member>\r
12434 <member name="T:NAnt.Contrib.Tasks.HxCompTask">\r
12435 <summary>\r
12436 Compiles a Microsoft HTML Help 2.0 Project.\r
12437 </summary>\r
12438 <example>\r
12439 <para>Compile a help file.</para>\r
12440 <code>\r
12441 <![CDATA[\r
12442 <hxcomp contents="MyContents.HxC" output="MyHelpFile.HxS" projectroot="HelpSourceFolder" />\r
12443 ]]>\r
12444 </code>\r
12445 </example>\r
12446 </member>\r
12447 <member name="P:NAnt.Contrib.Tasks.HxCompTask.Contents">\r
12448 <summary>\r
12449 The name of the contents (.HxC) file.\r
12450 </summary>\r
12451 </member>\r
12452 <member name="P:NAnt.Contrib.Tasks.HxCompTask.LogFile">\r
12453 <summary>\r
12454 ANSI/DBCS log filename.\r
12455 </summary>\r
12456 </member>\r
12457 <member name="P:NAnt.Contrib.Tasks.HxCompTask.UnicodeLogFile">\r
12458 <summary>\r
12459 Unicode log filename.\r
12460 </summary>\r
12461 </member>\r
12462 <member name="P:NAnt.Contrib.Tasks.HxCompTask.ProjectRoot">\r
12463 <summary>\r
12464 Root directory containing Help 2.0 project files.\r
12465 </summary>\r
12466 </member>\r
12467 <member name="P:NAnt.Contrib.Tasks.HxCompTask.OutputFile">\r
12468 <summary>\r
12469 Output (.HxS) filename.\r
12470 </summary>\r
12471 </member>\r
12472 <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoInformation">\r
12473 <summary>\r
12474 Generate no informational messages.\r
12475 </summary>\r
12476 </member>\r
12477 <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoErrors">\r
12478 <summary>\r
12479 Generate no error messages.\r
12480 </summary>\r
12481 </member>\r
12482 <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoWarnings">\r
12483 <summary>\r
12484 Generate no warning messages.\r
12485 </summary>\r
12486 </member>\r
12487 <member name="P:NAnt.Contrib.Tasks.HxCompTask.UncompileFile">\r
12488 <summary>\r
12489 File to be decompiled.\r
12490 </summary>\r
12491 </member>\r
12492 <member name="P:NAnt.Contrib.Tasks.HxCompTask.UncompileOutputDir">\r
12493 <summary>\r
12494 Directory to place decompiled files into.\r
12495 </summary>\r
12496 </member>\r
12497 <member name="P:NAnt.Contrib.Tasks.HxCompTask.ProgramArguments">\r
12498 <summary>\r
12499 Arguments of program to execute\r
12500 </summary>\r
12501 </member>\r
12502 <member name="T:NAnt.Contrib.Tasks.HxRegTask">\r
12503 <summary>\r
12504 Registers a Microsoft HTML Help 2.0 Collection.\r
12505 </summary>\r
12506 <example>\r
12507 <para>Register a help namespace.</para>\r
12508 <code>\r
12509 <![CDATA[\r
12510 <hxreg namespace="MyProduct.MyHelp" title="MyProductHelp" collection="MyHelp.HxC" helpfile="MyHelp.HxS" />\r
12511 ]]>\r
12512 </code>\r
12513 </example>\r
12514 </member>\r
12515 <member name="P:NAnt.Contrib.Tasks.HxRegTask.Namespace">\r
12516 <summary>Help collection namespace.</summary>\r
12517 </member>\r
12518 <member name="P:NAnt.Contrib.Tasks.HxRegTask.Title">\r
12519 <summary>Title identifier.</summary>\r
12520 </member>\r
12521 <member name="P:NAnt.Contrib.Tasks.HxRegTask.Collection">\r
12522 <summary>Collection (.HxC) filename. </summary>\r
12523 </member>\r
12524 <member name="P:NAnt.Contrib.Tasks.HxRegTask.Description">\r
12525 <summary>Description of the namespace.</summary>\r
12526 </member>\r
12527 <member name="P:NAnt.Contrib.Tasks.HxRegTask.HelpFile">\r
12528 <summary>Help (.HxS) filename.</summary>\r
12529 </member>\r
12530 <member name="P:NAnt.Contrib.Tasks.HxRegTask.Index">\r
12531 <summary>Index (.HxI) filename.</summary>\r
12532 </member>\r
12533 <member name="P:NAnt.Contrib.Tasks.HxRegTask.SearchFile">\r
12534 <summary>Combined full-text search (.HxQ) filename.</summary>\r
12535 </member>\r
12536 <member name="P:NAnt.Contrib.Tasks.HxRegTask.AttrIndex">\r
12537 <summary>Combined attribute index (.HxR) filename.</summary>\r
12538 </member>\r
12539 <member name="P:NAnt.Contrib.Tasks.HxRegTask.Language">\r
12540 <summary>Language ID.</summary>\r
12541 </member>\r
12542 <member name="P:NAnt.Contrib.Tasks.HxRegTask.Alias">\r
12543 <summary>Alias.</summary>\r
12544 </member>\r
12545 <member name="P:NAnt.Contrib.Tasks.HxRegTask.CommandFile">\r
12546 <summary>Filename of a file containing HxReg commands.</summary>\r
12547 </member>\r
12548 <member name="P:NAnt.Contrib.Tasks.HxRegTask.UnRegister">\r
12549 <summary>Unregister a namespace, title, or alias.</summary>\r
12550 </member>\r
12551 <member name="P:NAnt.Contrib.Tasks.HxRegTask.ProgramArguments">\r
12552 <summary>\r
12553 Arguments of program to execute\r
12554 </summary>\r
12555 </member>\r
12556 <member name="T:NAnt.Contrib.Tasks.MgmtClassGenTask">\r
12557 <summary>\r
12558 A task that generates strongly typed WMI classes using \r
12559 <c>mgmtclassgen.exe</c>.\r
12560 </summary>\r
12561 <remarks>\r
12562 The Management Strongly Typed Class Generator \r
12563 enables you to quickly generate an early-bound \r
12564 managed class for a specified Windows Management \r
12565 Instrumentation (WMI) class. The generated \r
12566 class simplifies the code you must write to access \r
12567 an instance of the WMI class.\r
12568 </remarks>\r
12569 <example>\r
12570 <code>\r
12571 <![CDATA[\r
12572 <mgmtclassgen \r
12573 wmiclass="Win32_LogicalDisk" \r
12574 language="CS"\r
12575 machine="SomeMachine"\r
12576 path="Root\cimv2"\r
12577 namespace="Winterdom.WMI"\r
12578 out="${outputdir}\LogicalDisk.cs"\r
12579 username="Administrator"\r
12580 password="password"\r
12581 />\r
12582 ]]>\r
12583 </code>\r
12584 </example>\r
12585 </member>\r
12586 <member name="M:NAnt.Contrib.Tasks.MgmtClassGenTask.InitializeTask(System.Xml.XmlNode)">\r
12587 <summary>\r
12588 Initializes task and ensures the supplied attributes are valid.\r
12589 </summary>\r
12590 <param name="taskNode">Xml node used to define this task instance.</param>\r
12591 </member>\r
12592 <member name="M:NAnt.Contrib.Tasks.MgmtClassGenTask.ExecuteTask">\r
12593 <summary>\r
12594 This is where the work is done\r
12595 </summary>\r
12596 </member>\r
12597 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.WmiClass">\r
12598 <summary>\r
12599 Specifies the name of the WMI class\r
12600 to generate the strongly typed class\r
12601 </summary>\r
12602 </member>\r
12603 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Language">\r
12604 <summary>\r
12605 Specifies the language in which to generate\r
12606 the class. Possible values are: CS, VB, JS\r
12607 </summary>\r
12608 </member>\r
12609 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Machine">\r
12610 <summary>\r
12611 Specifies the machine to connect to.\r
12612 </summary>\r
12613 </member>\r
12614 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Path">\r
12615 <summary>\r
12616 Specifies the path to the WMI namespace\r
12617 that contains the class.\r
12618 </summary>\r
12619 </member>\r
12620 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Namespace">\r
12621 <summary>\r
12622 Namespace of the generated .NET class\r
12623 </summary>\r
12624 </member>\r
12625 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.OutFile">\r
12626 <summary>\r
12627 Path of the file to generate\r
12628 </summary>\r
12629 </member>\r
12630 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Username">\r
12631 <summary>\r
12632 User name to use when connecting to\r
12633 the specified machine\r
12634 </summary>\r
12635 </member>\r
12636 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Password">\r
12637 <summary>\r
12638 Password to use when connecting to the \r
12639 specified machine\r
12640 </summary>\r
12641 </member>\r
12642 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.ProgramFileName">\r
12643 <summary>\r
12644 Filename of program to execute\r
12645 </summary>\r
12646 </member>\r
12647 <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.ProgramArguments">\r
12648 <summary>\r
12649 Arguments of program to execute\r
12650 </summary>\r
12651 </member>\r
12652 <member name="T:NAnt.Contrib.Tasks.NGenTask">\r
12653 <summary>\r
12654 Pre-translates native code for an assembly containing IL (Intermediary \r
12655 Language bytecode) on the Windows platform.\r
12656 </summary>\r
12657 <example>\r
12658 <code>\r
12659 <![CDATA[\r
12660 <ngen assembly="MyAssembly.dll" />\r
12661 ]]>\r
12662 </code>\r
12663 </example>\r
12664 </member>\r
12665 <member name="M:NAnt.Contrib.Tasks.NGenTask.InitializeTask(System.Xml.XmlNode)">\r
12666 <summary>\r
12667 Initializes task and ensures the supplied attributes are valid.\r
12668 </summary>\r
12669 <param name="taskNode">Xml node used to define this task instance.</param>\r
12670 </member>\r
12671 <member name="P:NAnt.Contrib.Tasks.NGenTask.Assembly">\r
12672 <summary>Assembly path or display name.</summary>\r
12673 </member>\r
12674 <member name="P:NAnt.Contrib.Tasks.NGenTask.Show">\r
12675 <summary>If existing images should be shown.</summary>\r
12676 </member>\r
12677 <member name="P:NAnt.Contrib.Tasks.NGenTask.Delete">\r
12678 <summary>If existing images should be deleted.</summary>\r
12679 </member>\r
12680 <member name="P:NAnt.Contrib.Tasks.NGenTask.Debug">\r
12681 <summary>If an image should be generated which\r
12682 can be used under a debugger.</summary>\r
12683 </member>\r
12684 <member name="P:NAnt.Contrib.Tasks.NGenTask.DebugOptimized">\r
12685 <summary>If an image should be generated which\r
12686 can be used under a debugger in optimized\r
12687 debugging mode.</summary>\r
12688 </member>\r
12689 <member name="P:NAnt.Contrib.Tasks.NGenTask.Profiled">\r
12690 <summary>If an image should be generated which\r
12691 can be used under a profiler.</summary>\r
12692 </member>\r
12693 <member name="P:NAnt.Contrib.Tasks.NGenTask.ProgramArguments">\r
12694 <summary>\r
12695 Arguments of program to execute\r
12696 </summary>\r
12697 </member>\r
12698 <member name="T:NAnt.Contrib.Tasks.NUnitReportTask">\r
12699 <summary>\r
12700 A task that generates a summary HTML\r
12701 from a set of NUnit xml report files.\r
12702 Loosely based on Erik Hatcher JUnitReport for Ant.\r
12703 </summary>\r
12704 <remarks>\r
12705 This task can generate a combined HTML report out of a\r
12706 set of NUnit result files generated using the \r
12707 XML Result Formatter.\r
12708 \r
12709 By default, NUnitReport will generate the combined\r
12710 report using the NUnitSummary.xsl file located at the\r
12711 assembly's location, but you can specify a different\r
12712 XSLT template to use with the <code>xslfile</code>\r
12713 attribute.\r
12714 \r
12715 Also, all the properties defined in the current\r
12716 project will be passed down to the XSLT file as \r
12717 template parameters, so you can access properties\r
12718 such as nant.project.name, nant.version, etc.\r
12719 </remarks>\r
12720 <example>\r
12721 <code><![CDATA[\r
12722 <nunitreport \r
12723 out="${outputdir}\TestSummary.html"\r
12724 >\r
12725 <fileset>\r
12726 <include name="${outputdir}\Test-*.xml" />\r
12727 </fileset>\r
12728 </nunitreport>\r
12729 \r
12730 ]]></code>\r
12731 </example>\r
12732 </member>\r
12733 <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.InitializeTask(System.Xml.XmlNode)">\r
12734 <summary>\r
12735 Initializes task and ensures the supplied attributes are valid.\r
12736 </summary>\r
12737 <param name="taskNode">Xml node used to define this task instance.</param>\r
12738 </member>\r
12739 <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.ExecuteTask">\r
12740 <summary>\r
12741 This is where the work is done\r
12742 </summary>\r
12743 </member>\r
12744 <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.CreateSummaryXmlDoc">\r
12745 <summary>\r
12746 Initializes the XmlDocument instance\r
12747 used to summarize the test results\r
12748 </summary>\r
12749 <returns></returns>\r
12750 </member>\r
12751 <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.GetPropertyList">\r
12752 <summary>\r
12753 Builds an XsltArgumentList with all\r
12754 the properties defined in the \r
12755 current project as XSLT parameters.\r
12756 </summary>\r
12757 <returns>Property List</returns>\r
12758 </member>\r
12759 <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.LoadTransform">\r
12760 <summary>\r
12761 Loads the XSLT Transform\r
12762 </summary>\r
12763 <remarks>\r
12764 This method will load the file specified\r
12765 through the the xslfile attribute, or\r
12766 the default transformation included\r
12767 as a managed resource.\r
12768 </remarks>\r
12769 <returns>The Transformation to use</returns>\r
12770 </member>\r
12771 <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.OutFilename">\r
12772 <summary>\r
12773 Name of Output HTML file.\r
12774 </summary>\r
12775 </member>\r
12776 <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.XslFile">\r
12777 <summary>\r
12778 XSLT file used to generate the report.\r
12779 </summary>\r
12780 </member>\r
12781 <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.XmlFileSet">\r
12782 <summary>\r
12783 Set of XML files to use as input\r
12784 </summary>\r
12785 </member>\r
12786 <member name="T:NAnt.Contrib.Tasks.NUnitReportTask.LocalResXmlResolver">\r
12787 <summary>\r
12788 Custom XmlResolver used to load the \r
12789 XSLT files out of this assembly resources.\r
12790 </summary>\r
12791 </member>\r
12792 <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.LocalResXmlResolver.GetEntity(System.Uri,System.String,System.Type)">\r
12793 <summary>\r
12794 Loads the XSLT file\r
12795 </summary>\r
12796 <param name="absoluteUri"></param>\r
12797 <param name="role"></param>\r
12798 <param name="objToReturn"></param>\r
12799 <returns></returns>\r
12800 </member>\r
12801 <member name="T:NAnt.Contrib.Tasks.RecordTask">\r
12802 <summary>\r
12803 A task that records the build's output to a file. Loosely based on Ant's \r
12804 <a href="http://ant.apache.org/manual/CoreTasks/recorder.html">Record</a>\r
12805 task.\r
12806 </summary>\r
12807 <remarks>\r
12808 This task allows you to record the build's output, or parts of it to a \r
12809 file. You can start and stop recording at any place in the build process.\r
12810 </remarks>\r
12811 <example>\r
12812 <code>\r
12813 <![CDATA[\r
12814 <record name="${outputdir}\Buildlog.txt" level="Info" action="Start"/>\r
12815 <record name="${outputdir}\Buildlog.txt" action="Close"/>\r
12816 ]]>\r
12817 </code>\r
12818 </example>\r
12819 </member>\r
12820 <member name="M:NAnt.Contrib.Tasks.RecordTask.ExecuteTask">\r
12821 <summary>\r
12822 This is where the work is done.\r
12823 </summary>\r
12824 </member>\r
12825 <member name="P:NAnt.Contrib.Tasks.RecordTask.LogName">\r
12826 <summary>\r
12827 Name of destination file.\r
12828 </summary>\r
12829 </member>\r
12830 <member name="P:NAnt.Contrib.Tasks.RecordTask.Action">\r
12831 <summary>\r
12832 Action to apply to this log instance - either <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/>,\r
12833 <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Stop"/>, <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Close"/> or\r
12834 <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Flush"/>.\r
12835 </summary>\r
12836 </member>\r
12837 <member name="P:NAnt.Contrib.Tasks.RecordTask.AutoFlush">\r
12838 <summary>\r
12839 Determines whether the recorder will flush it's buffer after every \r
12840 write to it. The default is <see langword="false"/>.\r
12841 </summary>\r
12842 <remarks>\r
12843 Effective only with the <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/> action.\r
12844 </remarks>\r
12845 </member>\r
12846 <member name="P:NAnt.Contrib.Tasks.RecordTask.ThresholdLevel">\r
12847 <summary>\r
12848 Determine the level of logging - either <see cref="F:NAnt.Core.Level.Debug"/>, \r
12849 <see cref="F:NAnt.Core.Level.Verbose"/>, <see cref="F:NAnt.Core.Level.Info"/>, \r
12850 <see cref="F:NAnt.Core.Level.Warning"/> or <see cref="F:NAnt.Core.Level.Error"/>. \r
12851 The default is <see cref="F:NAnt.Core.Level.Info"/>.\r
12852 </summary>\r
12853 <remarks>\r
12854 Effective only with the <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/> action.\r
12855 </remarks>\r
12856 </member>\r
12857 <member name="T:NAnt.Contrib.Tasks.RegasmTask">\r
12858 <summary>\r
12859 Registers an assembly for use from COM clients.\r
12860 </summary>\r
12861 <remarks>\r
12862 <para>\r
12863 Refer to the <see href="ms-help://MS.VSCC/MS.MSDNVS/cptools/html/cpgrfassemblyregistrationtoolregasmexe.htm">Regasm</see> \r
12864 documentation for more information on the regasm tool.\r
12865 </para>\r
12866 </remarks>\r
12867 <example>\r
12868 <para>\r
12869 Register a single assembly.\r
12870 </para>\r
12871 <code>\r
12872 <![CDATA[\r
12873 <regasm assembly="myAssembly.dll" />\r
12874 ]]>\r
12875 </code>\r
12876 </example>\r
12877 <example>\r
12878 <para>\r
12879 Register an assembly while exporting a typelibrary.\r
12880 </para>\r
12881 <code>\r
12882 <![CDATA[\r
12883 <regasm assembly="myAssembly.dll" typelib="myAssembly.tlb" />\r
12884 ]]>\r
12885 </code>\r
12886 </example>\r
12887 <example>\r
12888 <para>\r
12889 Register a set of assemblies at once.\r
12890 </para>\r
12891 <code>\r
12892 <![CDATA[\r
12893 <regasm unregister="false" codebase="true">\r
12894 <fileset>\r
12895 <include name="**/*.dll" />\r
12896 <exclude name="notanassembly.dll" />\r
12897 </fileset>\r
12898 </regasm>\r
12899 ]]>\r
12900 </code>\r
12901 </example>\r
12902 </member>\r
12903 <member name="P:NAnt.Contrib.Tasks.RegasmTask.AssemblyFile">\r
12904 <summary>\r
12905 The name of the file to register. This is provided as an alternate \r
12906 to using the task's fileset.\r
12907 </summary>\r
12908 </member>\r
12909 <member name="P:NAnt.Contrib.Tasks.RegasmTask.RegistryFile">\r
12910 <summary>\r
12911 Registry file to export to instead of entering the types directly \r
12912 into the registry. If a fileset is used then the entries are all \r
12913 collated into this file.\r
12914 </summary>\r
12915 </member>\r
12916 <member name="P:NAnt.Contrib.Tasks.RegasmTask.CodeBase">\r
12917 <summary>\r
12918 Set the code base registry setting.\r
12919 </summary>\r
12920 </member>\r
12921 <member name="P:NAnt.Contrib.Tasks.RegasmTask.ExportTypelib">\r
12922 <summary>\r
12923 Export a typelib and register it. The typelib will have the same \r
12924 name as the source assembly unless the <see cref="P:NAnt.Contrib.Tasks.RegasmTask.TypeLib"/> \r
12925 attribute is used.\r
12926 </summary>\r
12927 </member>\r
12928 <member name="P:NAnt.Contrib.Tasks.RegasmTask.Registered">\r
12929 <summary>\r
12930 Only refer to already registered type libraries.\r
12931 </summary>\r
12932 </member>\r
12933 <member name="P:NAnt.Contrib.Tasks.RegasmTask.TypeLib">\r
12934 <summary>\r
12935 Export the assembly to the specified type library and register it.\r
12936 This attribute is ignored when a fileset is specified.\r
12937 </summary>\r
12938 </member>\r
12939 <member name="P:NAnt.Contrib.Tasks.RegasmTask.Unregister">\r
12940 <summary>\r
12941 Unregister the assembly. The default is <see langword="false" />.\r
12942 </summary>\r
12943 </member>\r
12944 <member name="P:NAnt.Contrib.Tasks.RegasmTask.RegasmFileSet">\r
12945 <summary>\r
12946 The set of files to register.\r
12947 </summary>\r
12948 </member>\r
12949 <member name="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute">\r
12950 <summary>\r
12951 Indicates that class should be validated by an XML Schema.\r
12952 </summary>\r
12953 <remarks>None.</remarks>\r
12954 </member>\r
12955 <member name="M:NAnt.Contrib.Tasks.SchemaValidatorAttribute.#ctor(System.Type)">\r
12956 <summary>\r
12957 Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute"/>\r
12958 class.\r
12959 </summary>\r
12960 <param name="schemaType">The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.</param>\r
12961 </member>\r
12962 <member name="M:NAnt.Contrib.Tasks.SchemaValidatorAttribute.#ctor(System.Type,System.String)">\r
12963 <summary>\r
12964 Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute"/>\r
12965 class.\r
12966 </summary>\r
12967 <param name="schemaType">The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.</param>\r
12968 <param name="xmlNamespace"></param>\r
12969 </member>\r
12970 <member name="P:NAnt.Contrib.Tasks.SchemaValidatorAttribute.ValidatorType">\r
12971 <summary>\r
12972 Gets or sets the <see cref="T:System.Type"/> of the object created by \r
12973 <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.\r
12974 </summary>\r
12975 <value>\r
12976 The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/>\r
12977 to represent the root node of your task.\r
12978 </value>\r
12979 </member>\r
12980 <member name="T:NAnt.Contrib.Tasks.SchemeType">\r
12981 <summary>\r
12982 Defines possible reference counting scheme types for the <see cref="T:NAnt.Contrib.Tasks.GacTask">GAC</see> tasks.\r
12983 </summary>\r
12984 </member>\r
12985 <member name="F:NAnt.Contrib.Tasks.SchemeType.None">\r
12986 <summary>\r
12987 Specifies that no reference counting scheme will be used when performing the GAC task.\r
12988 </summary>\r
12989 </member>\r
12990 <member name="F:NAnt.Contrib.Tasks.SchemeType.UninstallKey">\r
12991 <summary>\r
12992 Specifies that registry-related reference counting will be used when performing the GAC task.\r
12993 </summary>\r
12994 <remarks>\r
12995 When the scheme type is set to <c>UninstallKey</c>, the related scheme ID should be set to the name of the application\r
12996 set in the <c>HKLM\Software\Microsoft\Windows\CurrentVersion</c> registry key.\r
12997 </remarks>\r
12998 \r
12999 </member>\r
13000 <member name="F:NAnt.Contrib.Tasks.SchemeType.FilePath">\r
13001 <summary>\r
13002 Specifies that file-based reference counting will be used when performing the GAC task.\r
13003 </summary>\r
13004 <remarks>\r
13005 When the scheme type is set to <c>FilePath</c>, the related scheme ID should be set to the full path to the executable\r
13006 file that installs the assembly.\r
13007 </remarks>\r
13008 \r
13009 </member>\r
13010 <member name="F:NAnt.Contrib.Tasks.SchemeType.Opaque">\r
13011 <summary>\r
13012 Specifies that custom information will be supplied to accommodate reference counting.\r
13013 </summary>\r
13014 <remarks>\r
13015 When the scheme type is set to <c>Opaque</c>, the related scheme ID can be set to any custom piece of information.\r
13016 </remarks>\r
13017 </member>\r
13018 <member name="T:NAnt.Contrib.Tasks.ScpTask">\r
13019 <summary>\r
13020 Copies a file to a remote server using scp.\r
13021 </summary>\r
13022 <remarks>\r
13023 <para>Copies a file using scp to a remote server.</para>\r
13024 <para>The Username Environment variable is used.</para>\r
13025 </remarks>\r
13026 <example>\r
13027 <para>Copy a single file to a remote server and path.</para>\r
13028 <code>\r
13029 <![CDATA[\r
13030 <scp file="myfile.zip" server="myServer" path="~" />\r
13031 ]]>\r
13032 </code>\r
13033 </example>\r
13034 </member>\r
13035 <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramName">\r
13036 <summary>\r
13037 The program to execute. The default is "scp".\r
13038 </summary>\r
13039 </member>\r
13040 <member name="P:NAnt.Contrib.Tasks.ScpTask.Options">\r
13041 <summary>\r
13042 The command line arguments.\r
13043 </summary>\r
13044 </member>\r
13045 <member name="P:NAnt.Contrib.Tasks.ScpTask.FileName">\r
13046 <summary>\r
13047 The file to transfer.\r
13048 </summary>\r
13049 </member>\r
13050 <member name="P:NAnt.Contrib.Tasks.ScpTask.ServerName">\r
13051 <summary>\r
13052 The server to send the file to.\r
13053 </summary>\r
13054 </member>\r
13055 <member name="P:NAnt.Contrib.Tasks.ScpTask.RemotePath">\r
13056 <summary>\r
13057 The path on the remote server. The default is "~".\r
13058 </summary>\r
13059 </member>\r
13060 <member name="P:NAnt.Contrib.Tasks.ScpTask.UserName">\r
13061 <summary>\r
13062 The username to connect as. The default is the value of the \r
13063 <c>USERNAME</c> environment variable.\r
13064 </summary>\r
13065 </member>\r
13066 <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramPathSep">\r
13067 <summary>\r
13068 The path separator used by the program. The default is "/".\r
13069 </summary>\r
13070 </member>\r
13071 <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramFileName">\r
13072 <summary>\r
13073 Gets the filename of the external program to start.\r
13074 </summary>\r
13075 <value>\r
13076 The filename of the external program.\r
13077 </value>\r
13078 </member>\r
13079 <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramArguments">\r
13080 <summary>\r
13081 Gets the command-line arguments for the external program.\r
13082 </summary>\r
13083 <value>\r
13084 The command-line arguments for the external program.\r
13085 </value>\r
13086 </member>\r
13087 <member name="P:NAnt.Contrib.Tasks.ScpTask.BaseDirectory">\r
13088 <summary>\r
13089 The directory in which the command will be executed.\r
13090 </summary>\r
13091 </member>\r
13092 <member name="T:NAnt.Contrib.Tasks.SlingshotTask">\r
13093 <summary>\r
13094 Converts a Visual Studio.NET Solution to a NAnt build file or nmake file.\r
13095 </summary>\r
13096 <example>\r
13097 <para>\r
13098 Convert the solution <c>MySolution.sln</c> to the NAnt build file \r
13099 <c>MySolution.build</c> and call the new build file.\r
13100 </para>\r
13101 <code>\r
13102 <![CDATA[\r
13103 <slingshot solution="MySolution.sln" format="nant" output="MySolution.build"> \r
13104 <parameters>\r
13105 <option name="build.basedir" value="..\bin"/>\r
13106 </parameters> \r
13107 </slingshot>\r
13108 <nant buildfile="MySolution.build"/>\r
13109 ]]>\r
13110 </code>\r
13111 </example>\r
13112 <example>\r
13113 <para>\r
13114 Convert the solution <c>MySolution.sln</c> to the NAnt build file \r
13115 <c>MySolution.build</c>. As the solution contains one or more web \r
13116 projects, one or more maps needs to be specified.\r
13117 </para>\r
13118 <code>\r
13119 <![CDATA[\r
13120 <slingshot solution="MySolution.sln" format="nant" output="MySolution.build">\r
13121 <parameters>\r
13122 <option name="build.basedir" value="..\bin"/>\r
13123 </parameters> \r
13124 <maps>\r
13125 <option name="http://localhost" value="C:\Inetpub\wwwroot"/>\r
13126 </maps>\r
13127 </slingshot>\r
13128 ]]>\r
13129 </code>\r
13130 </example>\r
13131 </member>\r
13132 <member name="M:NAnt.Contrib.Tasks.SlingshotTask.CreateSolutionWriter(System.String)">\r
13133 <summary>\r
13134 Creates the <see cref="T:SLiNgshoT.Core.SolutionWriter"/> for the specified format.\r
13135 </summary>\r
13136 <returns>\r
13137 The <see cref="T:SLiNgshoT.Core.SolutionWriter"/> for the specified format, or \r
13138 <see langword="null"/> if an unknown format was specified.\r
13139 </returns>\r
13140 </member>\r
13141 <member name="M:NAnt.Contrib.Tasks.SlingshotTask.OptionCollectionToHashtable(NAnt.Core.Types.OptionCollection,System.String)">\r
13142 <summary>\r
13143 Converts an <see cref="T:NAnt.Core.Types.OptionCollection"/> to a <see cref="T:System.Collections.Hashtable"/>.\r
13144 </summary>\r
13145 </member>\r
13146 <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Solution">\r
13147 <summary>\r
13148 The Visual Studio.NET solution file to convert.\r
13149 </summary>\r
13150 </member>\r
13151 <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Format">\r
13152 <summary>\r
13153 The output file format - either <c>nant</c> or <c>nmake</c>.\r
13154 </summary>\r
13155 </member>\r
13156 <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Output">\r
13157 <summary>\r
13158 The output file name.\r
13159 </summary>\r
13160 </member>\r
13161 <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Maps">\r
13162 <summary>\r
13163 Mappings from URI to directories. These are required for web projects.\r
13164 </summary>\r
13165 </member>\r
13166 <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Parameters">\r
13167 <summary>\r
13168 Parameters to pass to SLiNgshoT. The parameter <c>build.basedir</c> is required.\r
13169 </summary>\r
13170 </member>\r
13171 <member name="T:NAnt.Contrib.Tasks.SqlTask">\r
13172 <summary>\r
13173 A task to execute arbitrary SQL statements against a OLEDB data source.\r
13174 </summary>\r
13175 <remarks>\r
13176 You can specify a set of sql statements inside the\r
13177 sql element, or execute them from a text file that contains them. You can also\r
13178 choose to execute the statements in a single batch, or execute them one by one\r
13179 (even inside a transaction, if you want to).\r
13180 </remarks>\r
13181 <example>\r
13182 <para>\r
13183 Execute a set of statements inside a transaction.\r
13184 </para>\r
13185 <code>\r
13186 <![CDATA[\r
13187 <sql\r
13188 connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"\r
13189 transaction="true"\r
13190 delimiter=";"\r
13191 delimstyle="Normal"\r
13192 >\r
13193 INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('My Job', 22, 45);\r
13194 INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('Other Job', 09, 43);\r
13195 SELECT * FROM jobs;\r
13196 </sql>\r
13197 ]]>\r
13198 </code>\r
13199 </example>\r
13200 <example>\r
13201 <para>\r
13202 Execute a set of statements from a file and write all query results \r
13203 to a file.\r
13204 </para>\r
13205 <code>\r
13206 <![CDATA[\r
13207 <sql\r
13208 connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"\r
13209 transaction="true"\r
13210 delimiter=";"\r
13211 delimstyle="Normal"\r
13212 print="true"\r
13213 source="sql.txt"\r
13214 output="${outputdir}/results.txt"\r
13215 />\r
13216 ]]>\r
13217 </code>\r
13218 </example>\r
13219 <example>\r
13220 <para>\r
13221 Execute a SQL script generated by SQL Server Enterprise Manager.\r
13222 </para>\r
13223 <code>\r
13224 <![CDATA[\r
13225 <sql\r
13226 connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"\r
13227 transaction="true"\r
13228 delimiter="GO"\r
13229 delimstyle="Line"\r
13230 print="true"\r
13231 source="pubs.xml"\r
13232 batch="false"\r
13233 output="${outputdir}/results.txt"\r
13234 />\r
13235 ]]>\r
13236 </code>\r
13237 </example>\r
13238 </member>\r
13239 <member name="M:NAnt.Contrib.Tasks.SqlTask.InitializeTask(System.Xml.XmlNode)">\r
13240 <summary>\r
13241 Initializes task and ensures the supplied attributes are valid.\r
13242 </summary>\r
13243 <param name="taskNode">XML node used to define this task instance.</param>\r
13244 </member>\r
13245 <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteTask">\r
13246 <summary>\r
13247 This is where the work is done.\r
13248 </summary>\r
13249 </member>\r
13250 <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteStatements(NAnt.Contrib.Util.SqlHelper)">\r
13251 <summary>\r
13252 Executes the SQL Statements one by one.\r
13253 </summary>\r
13254 <param name="sqlHelper"></param>\r
13255 </member>\r
13256 <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteStatementsInBatch(NAnt.Contrib.Util.SqlHelper)">\r
13257 <summary>\r
13258 Executes the SQL statements in a single batch.\r
13259 </summary>\r
13260 <param name="sqlHelper"></param>\r
13261 </member>\r
13262 <member name="M:NAnt.Contrib.Tasks.SqlTask.ProcessResults(System.Data.IDataReader,System.IO.TextWriter)">\r
13263 <summary>\r
13264 Process a result set.\r
13265 </summary>\r
13266 <param name="results">Result set.</param>\r
13267 <param name="writer"><see cref="T:System.IO.TextWriter"/> to write output to.</param>\r
13268 </member>\r
13269 <member name="P:NAnt.Contrib.Tasks.SqlTask.ConnectionString">\r
13270 <summary>\r
13271 Connection string used to access database.\r
13272 This should be an OleDB connection string.\r
13273 </summary>\r
13274 </member>\r
13275 <member name="P:NAnt.Contrib.Tasks.SqlTask.Source">\r
13276 <summary>\r
13277 File where the sql statements are defined.\r
13278 </summary>\r
13279 <remarks>\r
13280 You cannot specify both a source and an inline set of statements.\r
13281 </remarks>\r
13282 </member>\r
13283 <member name="P:NAnt.Contrib.Tasks.SqlTask.Delimiter">\r
13284 <summary>\r
13285 String that separates statements from one another.\r
13286 </summary>\r
13287 </member>\r
13288 <member name="P:NAnt.Contrib.Tasks.SqlTask.Batch">\r
13289 <summary>\r
13290 If true, the statements will be executed as a single batch.\r
13291 If false, they will be executed one by one. Default is true.\r
13292 </summary>\r
13293 </member>\r
13294 <member name="P:NAnt.Contrib.Tasks.SqlTask.ExpandProperties">\r
13295 <summary>\r
13296 If true, the any nant-style properties on the sql will be\r
13297 expanded before execution. Default is true.\r
13298 </summary>\r
13299 </member>\r
13300 <member name="P:NAnt.Contrib.Tasks.SqlTask.CommandTimeout">\r
13301 <summary>\r
13302 Command timeout to use when creating commands.\r
13303 </summary>\r
13304 </member>\r
13305 <member name="P:NAnt.Contrib.Tasks.SqlTask.DelimiterStyle">\r
13306 <summary>\r
13307 Kind of delimiter used. Allowed values are Normal or Line.\r
13308 </summary>\r
13309 <remarks>\r
13310 Delimiters can be of two kinds: Normal delimiters are\r
13311 always specified inline, so they permit having two\r
13312 different statements in the same line. Line delimiters,\r
13313 however, need to be in a line by their own.\r
13314 Default is Normal.\r
13315 </remarks>\r
13316 </member>\r
13317 <member name="P:NAnt.Contrib.Tasks.SqlTask.Print">\r
13318 <summary>\r
13319 If set to true, results from the statements will be\r
13320 output to the build log.\r
13321 </summary>\r
13322 </member>\r
13323 <member name="P:NAnt.Contrib.Tasks.SqlTask.Output">\r
13324 <summary>\r
13325 If set, the results from the statements will be output to the \r
13326 specified file.\r
13327 </summary>\r
13328 </member>\r
13329 <member name="P:NAnt.Contrib.Tasks.SqlTask.UseTransaction">\r
13330 <summary>\r
13331 If set to <see langword="true" />, all statements will be executed\r
13332 within a single transaction. The default is <see langword="true" />.\r
13333 </summary>\r
13334 </member>\r
13335 <member name="P:NAnt.Contrib.Tasks.SqlTask.Append">\r
13336 <summary>\r
13337 Whether output should be appended to or overwrite\r
13338 an existing file. The default is <see langword="false" />.\r
13339 </summary>\r
13340 </member>\r
13341 <member name="P:NAnt.Contrib.Tasks.SqlTask.ShowHeaders">\r
13342 <summary>\r
13343 If set to <see langword="true" />, prints headers for result sets.\r
13344 The default is <see langword="true" />.\r
13345 </summary>\r
13346 </member>\r
13347 <member name="P:NAnt.Contrib.Tasks.SqlTask.QuoteChar">\r
13348 <summary>\r
13349 The character(s) to surround result columns with when printing, the \r
13350 default is an empty string.\r
13351 </summary>\r
13352 </member>\r
13353 <member name="P:NAnt.Contrib.Tasks.SqlTask.OutputWriter">\r
13354 <summary>\r
13355 Gets the underlying <see cref="T:System.IO.TextWriter"/> to which output will \r
13356 be written if <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/> is set.\r
13357 </summary>\r
13358 <value>\r
13359 A <see cref="T:System.IO.TextWriter"/> for the file specified in <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/>,\r
13360 or <see langword="null"/> if <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/> is not set.\r
13361 </value>\r
13362 </member>\r
13363 <member name="T:NAnt.Contrib.Tasks.TryCatchTask">\r
13364 <summary>\r
13365 Executes a set of tasks, and optionally catches a build exception to\r
13366 allow recovery or rollback steps to be taken, or to define some steps\r
13367 to be taken regardless if the tasks succeed or fail, or both.\r
13368 </summary>\r
13369 <remarks>\r
13370 <para>\r
13371 The tasks defined in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> block\r
13372 will be executed in turn, as they normally would in a target.\r
13373 </para>\r
13374 <para>\r
13375 If a <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block is defined, the \r
13376 tasks in that block will be executed in turn only if one of the tasks \r
13377 in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> block fails. This \r
13378 failure will then be suppressed by the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>\r
13379 block.\r
13380 </para>\r
13381 <para>\r
13382 The message associated with the failure can also be caught in a\r
13383 property for use within the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>\r
13384 block. The original contents of the property will be restored upon \r
13385 exiting the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block.\r
13386 </para>\r
13387 <para>\r
13388 If a <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c> block is defined, the \r
13389 tasks in that block will be executed after the tasks in both the \r
13390 <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> and <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>\r
13391 blocks have been executed, regardless of whether any task fails in \r
13392 either block.\r
13393 </para>\r
13394 </remarks>\r
13395 <example>\r
13396 <code>\r
13397 <![CDATA[\r
13398 <trycatch>\r
13399 <try>\r
13400 <echo message="In try" />\r
13401 <fail message="Failing!" />\r
13402 </try>\r
13403 <catch>\r
13404 <echo message="In catch" />\r
13405 </catch>\r
13406 <finally>\r
13407 <echo message="Finally done" />\r
13408 </finally>\r
13409 </trycatch>\r
13410 ]]>\r
13411 </code>\r
13412 <para>\r
13413 The output of this example will be:\r
13414 </para>\r
13415 <code>\r
13416 In try\r
13417 In catch\r
13418 Finally done\r
13419 </code>\r
13420 <para>\r
13421 The failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> block will \r
13422 not cause the build to fail.\r
13423 </para>\r
13424 </example>\r
13425 <example>\r
13426 <code>\r
13427 <![CDATA[\r
13428 <trycatch>\r
13429 <try>\r
13430 <echo message="In try" />\r
13431 <fail message="Just because..." />\r
13432 </try>\r
13433 <catch property="failure">\r
13434 <echo message="Caught failure: ${failure}" />\r
13435 <fail message="Bad catch" />\r
13436 </catch>\r
13437 <finally>\r
13438 <echo message="Finally done" />\r
13439 </finally>\r
13440 </trycatch>\r
13441 ]]>\r
13442 </code>\r
13443 <para>\r
13444 The output of this example will be:\r
13445 </para>\r
13446 <code>\r
13447 In try\r
13448 Caught failure: Just because...\r
13449 Finally done\r
13450 Build failed: Bad catch\r
13451 </code>\r
13452 <para>\r
13453 Like the above, the failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c>\r
13454 block does not cause the build to fail. The failure in the \r
13455 <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block does, however.\r
13456 Note that the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c> block is \r
13457 executed even though the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>\r
13458 block failed.\r
13459 </para>\r
13460 </example>\r
13461 <example>\r
13462 <code>\r
13463 <![CDATA[\r
13464 <trycatch>\r
13465 <try>\r
13466 <echo message="In try" />\r
13467 <fail message="yet again" />\r
13468 </try>\r
13469 <catch property="failure">\r
13470 <echo message="Caught failure ${failure}" />\r
13471 <fail message="Bad catch" />\r
13472 </catch>\r
13473 <finally>\r
13474 <echo message="Finally done ${failure}" />\r
13475 </finally>\r
13476 </trycatch>\r
13477 ]]>\r
13478 </code>\r
13479 <para>\r
13480 The output of this example will be:\r
13481 </para>\r
13482 <code>\r
13483 In try\r
13484 Caught failure yet again\r
13485 Build failed: Property 'failure' has not been set.\r
13486 </code>\r
13487 <para>\r
13488 The <see cref="T:NAnt.Core.Tasks.EchoTask"/> in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c>\r
13489 block failed because the "failure" property was not defined \r
13490 after exiting the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block. \r
13491 Note that the failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c> \r
13492 block has eclipsed the failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>\r
13493 block.\r
13494 </para>\r
13495 </example>\r
13496 <example>\r
13497 <code>\r
13498 <![CDATA[\r
13499 <trycatch>\r
13500 <try>\r
13501 <property name="temp.file" value="${path::get-temp-file-name()}" />\r
13502 <do-stuff to="${temp.file}" />\r
13503 <fail message="Oops..." />\r
13504 </try>\r
13505 <finally>\r
13506 <echo message="Cleaning up..." />\r
13507 <if test="${property::exists('temp.file')}">\r
13508 <delete file="${temp.file}" />\r
13509 </if>\r
13510 </finally>\r
13511 </trycatch>\r
13512 ]]>\r
13513 </code>\r
13514 <para>\r
13515 A more concrete example, that will always clean up the generated\r
13516 temporary file after it has been created.\r
13517 </para>\r
13518 </example>\r
13519 </member>\r
13520 <member name="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock">\r
13521 <summary>\r
13522 The tasks in this block will be executed as a normal part of\r
13523 the build script.\r
13524 </summary>\r
13525 </member>\r
13526 <member name="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock">\r
13527 <summary>\r
13528 The tasks in this block will be executed if any task in the try\r
13529 block fails.\r
13530 </summary>\r
13531 </member>\r
13532 <member name="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock">\r
13533 <summary>\r
13534 The tasks in this block will always be executed, regardless of\r
13535 what happens in the try and catch blocks.\r
13536 </summary>\r
13537 <remarks>\r
13538 Note that any failure in any of the tasks in this block will\r
13539 prevent any subsequent tasks from executing.\r
13540 </remarks>\r
13541 </member>\r
13542 <member name="P:NAnt.Contrib.Tasks.TryCatchTask.CatchElement.Property">\r
13543 <summary>\r
13544 Defines the name of the property to save the message describing\r
13545 the failure that has been caught.\r
13546 </summary>\r
13547 <remarks>\r
13548 <para>\r
13549 The failure message is only available in the context of the catch\r
13550 block. If you wish to preserve the message, you will need to save\r
13551 it into another property.\r
13552 </para>\r
13553 <para>\r
13554 Readonly properties cannot be overridden by this mechanism.\r
13555 </para>\r
13556 </remarks>\r
13557 </member>\r
13558 <member name="T:NAnt.Contrib.Tasks.TypedCollectionTask">\r
13559 <summary>Generates collection classes based on a given XML specification file. Code generation is in the specified language.</summary>\r
13560 <remarks>\r
13561 <para>See the <a href="http://www.sellsbrothers.com/tools/">CollectionGen tool page</a> for more information.</para>\r
13562 </remarks>\r
13563 <example> \r
13564 <code>\r
13565 <![CDATA[\r
13566 <typedcollection language="CSharp">\r
13567 <fileset>\r
13568 <include name="collections.xml" />\r
13569 </fileset>\r
13570 </typedcollection>\r
13571 ]]>\r
13572 </code>\r
13573 </example>\r
13574 </member>\r
13575 <member name="M:NAnt.Contrib.Tasks.TypedCollectionTask.GenerateCollectionClasses(System.String,System.String)">\r
13576 <summary>\r
13577 The actual generation work is done here.\r
13578 </summary>\r
13579 <param name="path"></param>\r
13580 <param name="language"></param>\r
13581 </member>\r
13582 <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.Language">\r
13583 <summary>The language to generate collection classes for. Valid values are "CSharp" or "VB".</summary>\r
13584 </member>\r
13585 <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.FileName">\r
13586 <summary>The name of the template file for collection generation. This is provided as an alternate to using the task's fileset.</summary>\r
13587 </member>\r
13588 <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.TypedCollFileSet">\r
13589 <summary>\r
13590 All files in this fileset will be run thru the collection generator.\r
13591 </summary>\r
13592 </member>\r
13593 <member name="T:NAnt.Contrib.Tasks.ValidateXmlTask">\r
13594 <summary>\r
13595 Validates a set of XML files based on a set of XML Schemas (XSD).\r
13596 </summary>\r
13597 <example>\r
13598 <code>\r
13599 <![CDATA[\r
13600 <validatexml>\r
13601 <schemas>\r
13602 <schema source="rcf-schema.xsd" />\r
13603 <schema namespace="urn:schemas-company-com:base" source="base-schema.xsd" />\r
13604 </schemas>\r
13605 <files>\r
13606 <include name="*.xml" />\r
13607 </files>\r
13608 </validatexml>\r
13609 ]]>\r
13610 </code>\r
13611 </example>\r
13612 </member>\r
13613 <member name="M:NAnt.Contrib.Tasks.ValidateXmlTask.ExecuteTask">\r
13614 <summary>\r
13615 This is where the work is done.\r
13616 </summary>\r
13617 </member>\r
13618 <member name="P:NAnt.Contrib.Tasks.ValidateXmlTask.XmlFiles">\r
13619 <summary>\r
13620 The XML files that must be validated.\r
13621 </summary>\r
13622 </member>\r
13623 <member name="P:NAnt.Contrib.Tasks.ValidateXmlTask.Schemas">\r
13624 <summary>\r
13625 The XML Schemas (XSD) to use for validation.\r
13626 </summary>\r
13627 </member>\r
13628 <member name="T:NAnt.Contrib.Tasks.Vb6Task">\r
13629 <summary>\r
13630 Compiles Microsoft Visual Basic 6 programs.\r
13631 </summary>\r
13632 <remarks>\r
13633 <para>Uses the VB6.EXE executable included with the Visual Basic 6 environment.</para>\r
13634 <para>The compiler uses the settings and source files specified in the project or group file.</para>\r
13635 </remarks>\r
13636 <example>\r
13637 <para>Build the project <c>HelloWorld.vbp</c> in the <c>build</c> directory.</para>\r
13638 <code>\r
13639 <![CDATA[\r
13640 <vb6 project="HelloWorld.vbp" outdir="build" />\r
13641 ]]>\r
13642 </code>\r
13643 </example>\r
13644 </member>\r
13645 <member name="M:NAnt.Contrib.Tasks.Vb6Task.ExecuteTask">\r
13646 <summary>\r
13647 Compiles the Visual Basic project or project group.\r
13648 </summary>\r
13649 </member>\r
13650 <member name="M:NAnt.Contrib.Tasks.Vb6Task.ParseGroupFile(System.IO.FileInfo)">\r
13651 <summary>\r
13652 Parses a VB group file and extract the file names of the sub-projects \r
13653 in the group.\r
13654 </summary>\r
13655 <param name="groupFile">The file name of the group file.</param>\r
13656 <returns>\r
13657 A string collection containing the list of sub-projects in the group.\r
13658 </returns>\r
13659 </member>\r
13660 <member name="M:NAnt.Contrib.Tasks.Vb6Task.ProjectNeedsCompiling(System.String)">\r
13661 <summary>\r
13662 Determines if a VB project needs to be recompiled by comparing the timestamp of \r
13663 the project's files and references to the timestamp of the last built version.\r
13664 </summary>\r
13665 <param name="projectFile">The file name of the project file.</param>\r
13666 <returns>\r
13667 <see langword="true" /> if the project should be compiled; otherwise,\r
13668 <see langword="false" />.\r
13669 </returns>\r
13670 </member>\r
13671 <member name="M:NAnt.Contrib.Tasks.Vb6Task.VB6GetTypeLibFile(System.Guid,System.UInt16,System.UInt16,System.UInt32)">\r
13672 <summary>\r
13673 VB6 uses a special algorithm to search for the typelib file. It doesn't \r
13674 rely on the API function QueryPathOfRegTypeLib, because VB could use a newer\r
13675 version of the TLB.\r
13676 \r
13677 The algorithm used by VB is not perfect and has some flaws, which you could\r
13678 get a newer version even if your requested version is installed. This is because\r
13679 the algorithm iterates the registry beneath the Guid - entry by entry - from the \r
13680 beginning and returns the first TLB version that is higher or equal to the \r
13681 requested version.\r
13682 \r
13683 pseudo code:\r
13684 1. open the key HKEY_CLASSES_ROOT\TypeLib\{Guid}\r
13685 2. If the key exists:\r
13686 3. Foreach version under the key that has the requested culture entry:\r
13687 4. If the version higher or equal to the requested version:\r
13688 5. Get the TLB filename and returns it\r
13689 </summary>\r
13690 <param name="guid">The guid of the tlb to look for</param>\r
13691 <param name="major">The major version number of the tlb</param>\r
13692 <param name="minor16">The minor version number of the tlb. If you parse minor from a string, treat the string as hex value.</param>\r
13693 <param name="lcid">The culture id</param>\r
13694 <returns>null if couldn't find a match, otherwise it returns the file.</returns>\r
13695 </member>\r
13696 <member name="M:NAnt.Contrib.Tasks.Vb6Task.ParseProjectFile(System.String,NAnt.Core.Types.FileSet,NAnt.Core.Types.FileSet)">\r
13697 <summary>\r
13698 Parses a VB project file and extracts the source files, reference files, and \r
13699 the name of the compiled file for the project.\r
13700 </summary>\r
13701 <param name="projectFile">The filename of the project file.</param>\r
13702 <param name="sources">\r
13703 A fileset representing the source files of the project, which will\r
13704 populated by the method.\r
13705 </param>\r
13706 <param name="references">\r
13707 A fileset representing the references of the project, which will\r
13708 populated by the method.\r
13709 </param>\r
13710 <returns>A string containing the output file name for the project.</returns>\r
13711 </member>\r
13712 <member name="P:NAnt.Contrib.Tasks.Vb6Task.OutDir">\r
13713 <summary>\r
13714 Output directory for the compilation target.\r
13715 </summary>\r
13716 </member>\r
13717 <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProjectFile">\r
13718 <summary>\r
13719 Visual Basic project or group file.\r
13720 </summary>\r
13721 </member>\r
13722 <member name="P:NAnt.Contrib.Tasks.Vb6Task.CheckReferences">\r
13723 <summary>\r
13724 Determines whether project references are checked when deciding \r
13725 whether the project needs to be recompiled. The default is \r
13726 <see langword="true" />.\r
13727 </summary>\r
13728 </member>\r
13729 <member name="P:NAnt.Contrib.Tasks.Vb6Task.ErrorFile">\r
13730 <summary>\r
13731 The file to which the Visual Basic compiler should log errors.\r
13732 </summary>\r
13733 </member>\r
13734 <member name="P:NAnt.Contrib.Tasks.Vb6Task.Conditionals">\r
13735 <summary>\r
13736 Tells Visual Basic which values to use for conditional compilation\r
13737 constants.\r
13738 </summary>\r
13739 </member>\r
13740 <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProgramFileName">\r
13741 <summary>\r
13742 Gets the filename of the external program to start.\r
13743 </summary>\r
13744 <value>\r
13745 The filename of the external program.\r
13746 </value>\r
13747 </member>\r
13748 <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProgramArguments">\r
13749 <summary>\r
13750 Gets the command-line arguments for the external program.\r
13751 </summary>\r
13752 <value>\r
13753 The command-line arguments for the external program.\r
13754 </value>\r
13755 </member>\r
13756 <member name="T:NAnt.Contrib.Tasks.VersionTask">\r
13757 <summary>\r
13758 Increments a four-part version number stored in a text file. The resulting \r
13759 version number is written back to the file and exposed using NAnt properties.\r
13760 </summary>\r
13761 <remarks>\r
13762 <para>\r
13763 The version number format in the text file is \r
13764 Major.Minor.Build.Revision, e.g. 1.0.5.25.\r
13765 </para>\r
13766 <list type="table">\r
13767 <item>\r
13768 <term>Major</term>\r
13769 <description>Set in file.</description>\r
13770 </item>\r
13771 <item>\r
13772 <term>Minor</term>\r
13773 <description>Set in file.</description>\r
13774 </item>\r
13775 <item>\r
13776 <term>Build</term>\r
13777 <description>Can be incremented by setting the <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/> parameter.</description>\r
13778 </item>\r
13779 <item>\r
13780 <term>Revision</term>\r
13781 <description>Can be incremented by setting the <see cref="P:NAnt.Contrib.Tasks.VersionTask.RevisionType"/> parameter.</description>\r
13782 </item>\r
13783 </list>\r
13784 <para>The following NAnt properties are created:</para>\r
13785 <list type="table"> \r
13786 <item>\r
13787 <term><c>prefix</c>.version</term>\r
13788 <description>The complete version number, i.e. Major.Minor.Build.Revision</description>\r
13789 </item>\r
13790 <item>\r
13791 <term><c>prefix</c>.major</term>\r
13792 <description>The major component of the version number.</description>\r
13793 </item>\r
13794 <item>\r
13795 <term><c>prefix</c>.minor</term>\r
13796 <description>The minor component of the version number.</description>\r
13797 </item>\r
13798 <item>\r
13799 <term><c>prefix</c>.build</term>\r
13800 <description>The build component of the version number.</description>\r
13801 </item>\r
13802 <item>\r
13803 <term><c>prefix</c>.revision</term>\r
13804 <description>The revision component of the version number.</description>\r
13805 </item>\r
13806 </list>\r
13807 </remarks>\r
13808 </member>\r
13809 <member name="M:NAnt.Contrib.Tasks.VersionTask.ReadVersionFromFile">\r
13810 <summary>\r
13811 Reads a version string from <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/> and returns it as a\r
13812 <see cref="T:System.Version"/> instance.\r
13813 </summary>\r
13814 <returns>\r
13815 A <see cref="T:System.Version"/> instance representing the version string in\r
13816 <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.\r
13817 </returns>\r
13818 </member>\r
13819 <member name="M:NAnt.Contrib.Tasks.VersionTask.WriteVersionToFile(System.Version)">\r
13820 <summary>\r
13821 Writes the specified version to <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.\r
13822 </summary>\r
13823 <param name="version">The version to write to <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.</param>\r
13824 </member>\r
13825 <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateMonthDayBuildNumber">\r
13826 <summary>\r
13827 Calculates the build number based on the number of months since the \r
13828 start date.\r
13829 </summary>\r
13830 <returns>\r
13831 The build number based on the number of months since the start date.\r
13832 </returns>\r
13833 </member>\r
13834 <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateSecondsSinceMidnight">\r
13835 <summary>\r
13836 Calculates the number of seconds since midnight. \r
13837 start date.\r
13838 </summary>\r
13839 <returns>\r
13840 The number of seconds since midnight.\r
13841 </returns>\r
13842 </member>\r
13843 <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateBuildNumber(System.Int32)">\r
13844 <summary>\r
13845 Calculates the build number of the version number based on \r
13846 <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/>.\r
13847 </summary>\r
13848 <returns>\r
13849 The build number.\r
13850 </returns>\r
13851 </member>\r
13852 <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateVersion">\r
13853 <summary>\r
13854 Calculates the complete version.\r
13855 </summary>\r
13856 <returns>\r
13857 The version.\r
13858 </returns>\r
13859 </member>\r
13860 <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateRevisionNumber(System.Version,System.Int32)">\r
13861 <summary>\r
13862 Calculates the revision number of the version number based on RevisionType specified\r
13863 </summary>\r
13864 <returns>\r
13865 The revision number.\r
13866 </returns>\r
13867 </member>\r
13868 <member name="P:NAnt.Contrib.Tasks.VersionTask.Prefix">\r
13869 <summary>\r
13870 The string to prefix the properties with. The default is \r
13871 <c>'buildnumber.'</c>.\r
13872 </summary>\r
13873 </member>\r
13874 <member name="P:NAnt.Contrib.Tasks.VersionTask.StartDate">\r
13875 <summary>\r
13876 Start of project. Date from which to calculate build number. \r
13877 Required if <see cref="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay"/> is used as \r
13878 <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/>.\r
13879 </summary>\r
13880 </member>\r
13881 <member name="P:NAnt.Contrib.Tasks.VersionTask.Path">\r
13882 <summary>\r
13883 Path to the file containing the current version number. The default \r
13884 file is <c>'build.number'</c> in the project base directory.\r
13885 </summary>\r
13886 </member>\r
13887 <member name="P:NAnt.Contrib.Tasks.VersionTask.BuildType">\r
13888 <summary>\r
13889 The algorithm for generating build number. The default is\r
13890 <see cref="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay"/>.\r
13891 </summary>\r
13892 </member>\r
13893 <member name="P:NAnt.Contrib.Tasks.VersionTask.RevisionType">\r
13894 <summary>\r
13895 The algorithm for generating revision number. The default is\r
13896 <see cref="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Automatic"/>.\r
13897 </summary>\r
13898 </member>\r
13899 <member name="T:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm">\r
13900 <summary>\r
13901 Defines possible algorithms to generate the build number.\r
13902 </summary>\r
13903 </member>\r
13904 <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay">\r
13905 <summary>\r
13906 Use the number of months since start of project * 100 + current \r
13907 day in month as build number.\r
13908 </summary>\r
13909 </member>\r
13910 <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.Increment">\r
13911 <summary>\r
13912 Increment an existing build number.\r
13913 </summary>\r
13914 </member>\r
13915 <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.NoIncrement">\r
13916 <summary>\r
13917 Use an existing build number (and do not increment it).\r
13918 </summary>\r
13919 </member>\r
13920 <member name="T:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm">\r
13921 <summary>\r
13922 Defines possible algorithms to generate the revision number.\r
13923 </summary>\r
13924 </member>\r
13925 <member name="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Automatic">\r
13926 <summary>\r
13927 Use the number of seconds since the start of today / 10.\r
13928 </summary>\r
13929 </member>\r
13930 <member name="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Increment">\r
13931 <summary>\r
13932 Increment an existing revision number.\r
13933 </summary>\r
13934 </member>\r
13935 <member name="T:NAnt.Contrib.Tasks.WsdlTask">\r
13936 <summary>Generates code for web service clients and xml web services\r
13937 using ASP.NET from WSDL contract files, XSD Schemas and .discomap\r
13938 discovery documents. Can be used in conjunction with .disco files.</summary>\r
13939 <example>\r
13940 <para>Generate a proxy class for a web service.</para>\r
13941 <code><![CDATA[<wsdl path="http://www.somewhere.com/myservice.wsdl"\r
13942 language="CS" namespace="MyCompany.MyService" outfile="MyService.cs" />]]></code>\r
13943 </example>\r
13944 </member>\r
13945 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Path">\r
13946 <summary>URL or Path to a WSDL, XSD, or .discomap document.</summary>\r
13947 </member>\r
13948 <member name="P:NAnt.Contrib.Tasks.WsdlTask.NoLogo">\r
13949 <summary>Suppresses the banner.</summary>\r
13950 </member>\r
13951 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Language">\r
13952 <summary>Language of generated code. 'CS', 'VB', 'JS',\r
13953 or the fully-qualified name of a class implementing\r
13954 System.CodeDom.Compiler.CodeDomCompiler. </summary>\r
13955 </member>\r
13956 <member name="P:NAnt.Contrib.Tasks.WsdlTask.ForServer">\r
13957 <summary>Compiles server-side ASP.NET abstract classes\r
13958 based on the web service contract. The default is to\r
13959 create client side proxy classes. </summary>\r
13960 </member>\r
13961 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Namespace">\r
13962 <summary>Microsoft.NET namespace of generated classes.</summary>\r
13963 </member>\r
13964 <member name="P:NAnt.Contrib.Tasks.WsdlTask.OutFile">\r
13965 <summary>Output filename of the created proxy. Default name is derived from the service name.</summary>\r
13966 </member>\r
13967 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Protocol">\r
13968 <summary>Override default protocol to implement. Choose from 'SOAP',\r
13969 'HttpGet', 'HttpPost', or a custom protocol as specified in the\r
13970 configuration file.</summary>\r
13971 </member>\r
13972 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Username">\r
13973 <summary>Username of an account with credentials to access a\r
13974 server that requires authentication.</summary>\r
13975 </member>\r
13976 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Password">\r
13977 <summary>Password of an account with credentials to access a\r
13978 server that requires authentication.</summary>\r
13979 </member>\r
13980 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Domain">\r
13981 <summary>Domain of an account with credentials to access a\r
13982 server that requires authentication.</summary>\r
13983 </member>\r
13984 <member name="P:NAnt.Contrib.Tasks.WsdlTask.Proxy">\r
13985 <summary>URL of a proxy server to use for HTTP requests.\r
13986 The default is to use the system proxy setting.</summary>\r
13987 </member>\r
13988 <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyUsername">\r
13989 <summary>Username of an account with credentials to access a\r
13990 proxy that requires authentication.</summary>\r
13991 </member>\r
13992 <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyPassword">\r
13993 <summary>Password of an account with credentials to access a\r
13994 proxy that requires authentication.</summary>\r
13995 </member>\r
13996 <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyDomain">\r
13997 <summary>Domain of an account with credentials to access a\r
13998 proxy that requires authentication.</summary>\r
13999 </member>\r
14000 <member name="P:NAnt.Contrib.Tasks.WsdlTask.UrlKey">\r
14001 <summary>Configuration key to use in the code generation to\r
14002 read the default value for the Url property. The default is\r
14003 not to read from the config file.</summary>\r
14004 </member>\r
14005 <member name="P:NAnt.Contrib.Tasks.WsdlTask.BaseUrl">\r
14006 <summary>Base Url to use when calculating the Url fragment.\r
14007 The UrlKey attribute must also be specified. </summary>\r
14008 </member>\r
14009 <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProgramArguments">\r
14010 <summary>\r
14011 Gets the command-line arguments for the external program.\r
14012 </summary>\r
14013 <value>\r
14014 The command-line arguments for the external program.\r
14015 </value>\r
14016 </member>\r
14017 <member name="T:NAnt.Contrib.Tasks.XsdTask">\r
14018 <summary>\r
14019 The <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> generates XML schema or common language runtime \r
14020 classes from XDR, XML, and XSD files, or from classes in a runtime assembly.\r
14021 </summary>\r
14022 <remarks>\r
14023 <para>\r
14024 The following operations can be performed :\r
14025 </para>\r
14026 <list type="table">\r
14027 <listheader>\r
14028 <term>Operation</term>\r
14029 <description>Description</description>\r
14030 </listheader>\r
14031 <item>\r
14032 <term>XDR to XSD</term>\r
14033 <description>\r
14034 Generates an XML schema from an XML-Data-Reduced schema file. \r
14035 XDR is an early XML-based schema format. \r
14036 </description>\r
14037 </item>\r
14038 <item>\r
14039 <term>XML to XSD</term>\r
14040 <description>\r
14041 Generates an XML schema from an XML file.\r
14042 </description>\r
14043 </item>\r
14044 <item>\r
14045 <term>XSD to DataSet</term>\r
14046 <description>\r
14047 Generates common language runtime <see cref="T:System.Data.DataSet"/> \r
14048 classes from an XSD schema file. The generated classes \r
14049 provide a rich object model for regular XML data. \r
14050 </description>\r
14051 </item>\r
14052 <item>\r
14053 <term>XSD to Classes</term>\r
14054 <description>\r
14055 Generates runtime classes from an XSD schema file. The \r
14056 generated classes can be used in conjunction with \r
14057 <see cref="T:System.Xml.Serialization.XmlSerializer"/> to \r
14058 read and write XML code that follows the schema. \r
14059 </description>\r
14060 </item>\r
14061 <item>\r
14062 <term>Classes to XSD</term>\r
14063 <description>\r
14064 Generates an XML schema from a type or types in a runtime \r
14065 assembly file. The generated schema defines the XML format \r
14066 used by <see cref="T:System.Xml.Serialization.XmlSerializer"/>. \r
14067 </description>\r
14068 </item>\r
14069 </list>\r
14070 </remarks>\r
14071 <example>\r
14072 <para>Compile a XML Schema.</para>\r
14073 <code>\r
14074 <![CDATA[\r
14075 <xsd \r
14076 schema="MySchema.xsd" \r
14077 element="MyRootElement" \r
14078 language="CS" \r
14079 namespace="MyCompany.MySchema" \r
14080 outputdir="build\bin"\r
14081 uri="http://MySchema'sTargetNamespace" />\r
14082 ]]>\r
14083 </code>\r
14084 </example>\r
14085 <example>\r
14086 <para>Generate an XML Schema from an assembly.</para>\r
14087 <code>\r
14088 <![CDATA[\r
14089 <xsd assembly="MyAssembly.dll" outputdir="build\Schemas" />\r
14090 ]]>\r
14091 </code>\r
14092 </example>\r
14093 <example>\r
14094 <para>Generate an XML Schema from an XML document.</para>\r
14095 <code>\r
14096 <![CDATA[\r
14097 <xsd xmldoc="MyDoc.xml" outputdir="build\Schemas" />\r
14098 ]]>\r
14099 </code>\r
14100 </example>\r
14101 <example>\r
14102 <para>Generate an XML Schema from an XDR Schema.</para>\r
14103 <code>\r
14104 <![CDATA[\r
14105 <xsd xdr="MyOldSchema.xdr" outputdir="build\Schemas" />\r
14106 ]]>\r
14107 </code>\r
14108 </example>\r
14109 </member>\r
14110 <member name="M:NAnt.Contrib.Tasks.XsdTask.InitializeTask(System.Xml.XmlNode)">\r
14111 <summary>\r
14112 Validates the <see cref="T:NAnt.Core.Task"/>.\r
14113 </summary>\r
14114 <param name="taskNode">The <see cref="T:System.Xml.XmlNode"/> used to initialize the <see cref="T:NAnt.Core.Task"/>.</param>\r
14115 </member>\r
14116 <member name="P:NAnt.Contrib.Tasks.XsdTask.Schema">\r
14117 <summary>\r
14118 XML Schema (.xsd) filename.\r
14119 </summary>\r
14120 </member>\r
14121 <member name="P:NAnt.Contrib.Tasks.XsdTask.Target">\r
14122 <summary>\r
14123 Target of XML Schema compilation - either <c>classes</c> or \r
14124 <c>dataset</c>. The default is <c>classes</c>.\r
14125 </summary>\r
14126 </member>\r
14127 <member name="P:NAnt.Contrib.Tasks.XsdTask.Element">\r
14128 <summary>\r
14129 XML element in the Schema to process.\r
14130 </summary>\r
14131 <remarks>\r
14132 TO-DO : turn this into collection of elements !\r
14133 </remarks>\r
14134 </member>\r
14135 <member name="P:NAnt.Contrib.Tasks.XsdTask.Language">\r
14136 <summary>\r
14137 The language to use for the generated code - either <c>CS</c>, \r
14138 <c>VB</c>, <c>JS</c>, <c>VJC</c> or the fully-qualified name of a \r
14139 class implementing <see cref="T:System.CodeDom.Compiler.CodeDomProvider"/>.\r
14140 </summary>\r
14141 </member>\r
14142 <member name="P:NAnt.Contrib.Tasks.XsdTask.Namespace">\r
14143 <summary>\r
14144 Specifies the runtime namespace for the generated types. The default \r
14145 namespace is <c>Schemas</c>.\r
14146 </summary>\r
14147 </member>\r
14148 <member name="P:NAnt.Contrib.Tasks.XsdTask.OutputDir">\r
14149 <summary>\r
14150 The output directory in which to place generated files.\r
14151 </summary>\r
14152 </member>\r
14153 <member name="P:NAnt.Contrib.Tasks.XsdTask.Assembly">\r
14154 <summary>\r
14155 Assembly (.dll or .exe) to generate an XML Schema for.\r
14156 </summary>\r
14157 </member>\r
14158 <member name="P:NAnt.Contrib.Tasks.XsdTask.Types">\r
14159 <summary>\r
14160 Types in the assembly for which an XML schema is being created.\r
14161 By default all types in the assembly will be included.\r
14162 </summary>\r
14163 <remarks>\r
14164 TO-DO : turn this into collection of types !\r
14165 </remarks>\r
14166 </member>\r
14167 <member name="P:NAnt.Contrib.Tasks.XsdTask.Uri">\r
14168 <summary>\r
14169 Specifies the URI for the elements in the <see cref="P:NAnt.Contrib.Tasks.XsdTask.Schema"/> to \r
14170 generate code for. \r
14171 </summary>\r
14172 </member>\r
14173 <member name="P:NAnt.Contrib.Tasks.XsdTask.XmlDoc">\r
14174 <summary>\r
14175 XML document to generate an XML Schema for.\r
14176 </summary>\r
14177 </member>\r
14178 <member name="P:NAnt.Contrib.Tasks.XsdTask.Xdr">\r
14179 <summary>\r
14180 XDR Schema to generate an XML Schema for.\r
14181 </summary>\r
14182 </member>\r
14183 <member name="P:NAnt.Contrib.Tasks.XsdTask.ProgramArguments">\r
14184 <summary>\r
14185 Gets the command-line arguments for the external program.\r
14186 </summary>\r
14187 <value>\r
14188 The command-line arguments for the external program.\r
14189 </value>\r
14190 </member>\r
14191 <member name="T:NAnt.Contrib.Types.PVCS.Entity">\r
14192 <summary>\r
14193 Represents an entity in an <see cref="T:NAnt.Contrib.Types.PVCS.EntitySet"/>.\r
14194 </summary>\r
14195 </member>\r
14196 <member name="F:NAnt.Contrib.Types.PVCS.Entity._name">\r
14197 <see cref="P:NAnt.Contrib.Types.PVCS.Entity.Name"/>\r
14198 </member>\r
14199 <member name="F:NAnt.Contrib.Types.PVCS.Entity._if">\r
14200 <see cref="P:NAnt.Contrib.Types.PVCS.Entity.If"/>\r
14201 </member>\r
14202 <member name="F:NAnt.Contrib.Types.PVCS.Entity._unless">\r
14203 <see cref="P:NAnt.Contrib.Types.PVCS.Entity.Unless"/>\r
14204 </member>\r
14205 <member name="M:NAnt.Contrib.Types.PVCS.Entity.#ctor">\r
14206 <summary>\r
14207 Constructs and initializes an instance of <c>Entity</c>.\r
14208 </summary>\r
14209 </member>\r
14210 <member name="P:NAnt.Contrib.Types.PVCS.Entity.Name">\r
14211 <summary>\r
14212 The path for the entity.\r
14213 </summary>\r
14214 </member>\r
14215 <member name="P:NAnt.Contrib.Types.PVCS.Entity.If">\r
14216 <summary>\r
14217 If <c>true</c> then the entity will be included. The default is <c>true</c>.\r
14218 </summary>\r
14219 </member>\r
14220 <member name="P:NAnt.Contrib.Types.PVCS.Entity.Unless">\r
14221 <summary>\r
14222 Opposite of <see cref="P:NAnt.Contrib.Types.PVCS.Entity.If"/>. If <c>false</c> then the entity will be included. The default is\r
14223 <c>false</c>.\r
14224 </summary>\r
14225 </member>\r
14226 <member name="T:NAnt.Contrib.Types.PVCS.EntitySet">\r
14227 <summary>\r
14228 Represents a set of entities to include in a PVCS project database task.\r
14229 </summary>\r
14230 <seealso cref="T:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask"/>\r
14231 </member>\r
14232 <member name="F:NAnt.Contrib.Types.PVCS.EntitySet._entityPaths">\r
14233 <see cref="P:NAnt.Contrib.Types.PVCS.EntitySet.EntityPaths"/>\r
14234 </member>\r
14235 <member name="M:NAnt.Contrib.Types.PVCS.EntitySet.#ctor">\r
14236 <summary>\r
14237 Constructs and initializes an instance of <c>EntitySet</c>.\r
14238 </summary>\r
14239 </member>\r
14240 <member name="P:NAnt.Contrib.Types.PVCS.EntitySet.EntityPaths">\r
14241 <summary>\r
14242 Gets the collection of entity paths assigned to this entity set.\r
14243 </summary>\r
14244 </member>\r
14245 <member name="P:NAnt.Contrib.Types.PVCS.EntitySet.Entities">\r
14246 <summary>\r
14247 The entities to include in the project task.\r
14248 </summary>\r
14249 </member>\r
14250 <member name="T:NAnt.Contrib.Types.Assembly">\r
14251 <summary>\r
14252 Represents a single assembly in an <see cref="T:NAnt.Contrib.Types.AssemblySet"/>.\r
14253 </summary>\r
14254 </member>\r
14255 <member name="F:NAnt.Contrib.Types.Assembly._culture">\r
14256 <summary>\r
14257 See <see cref="P:NAnt.Contrib.Types.Assembly.Culture"/>.\r
14258 </summary>\r
14259 </member>\r
14260 <member name="F:NAnt.Contrib.Types.Assembly._if">\r
14261 <summary>\r
14262 See <see cref="P:NAnt.Contrib.Types.Assembly.If"/>.\r
14263 </summary>\r
14264 </member>\r
14265 <member name="F:NAnt.Contrib.Types.Assembly._name">\r
14266 <summary>\r
14267 See <see cref="P:NAnt.Contrib.Types.Assembly.Name"/>.\r
14268 </summary>\r
14269 </member>\r
14270 <member name="F:NAnt.Contrib.Types.Assembly._publicKeyToken">\r
14271 <summary>\r
14272 See <see cref="P:NAnt.Contrib.Types.Assembly.PublicKeyToken"/>.\r
14273 </summary>\r
14274 </member>\r
14275 <member name="F:NAnt.Contrib.Types.Assembly._unless">\r
14276 <summary>\r
14277 See <see cref="P:NAnt.Contrib.Types.Assembly.Unless"/>.\r
14278 </summary>\r
14279 </member>\r
14280 <member name="F:NAnt.Contrib.Types.Assembly._version">\r
14281 <summary>\r
14282 See <see cref="P:NAnt.Contrib.Types.Assembly.Version"/>.\r
14283 </summary>\r
14284 </member>\r
14285 <member name="M:NAnt.Contrib.Types.Assembly.#ctor">\r
14286 <summary>\r
14287 Constructs and initializes an instance of <c>Assembly</c>.\r
14288 </summary>\r
14289 </member>\r
14290 <member name="M:NAnt.Contrib.Types.Assembly.ToString">\r
14291 <summary>\r
14292 Converts this <c>Assembly</c> object into it's <c>string</c> representation.\r
14293 </summary>\r
14294 <returns></returns>\r
14295 </member>\r
14296 <member name="P:NAnt.Contrib.Types.Assembly.Culture">\r
14297 <summary>\r
14298 The culture for the assembly.\r
14299 </summary>\r
14300 </member>\r
14301 <member name="P:NAnt.Contrib.Types.Assembly.If">\r
14302 <summary>\r
14303 If <c>true</c> then the assembly will be included. The default is <c>true</c>.\r
14304 </summary>\r
14305 </member>\r
14306 <member name="P:NAnt.Contrib.Types.Assembly.Name">\r
14307 <summary>\r
14308 The name of the assembly.\r
14309 </summary>\r
14310 </member>\r
14311 <member name="P:NAnt.Contrib.Types.Assembly.PublicKeyToken">\r
14312 <summary>\r
14313 The public key token of the assembly.\r
14314 </summary>\r
14315 </member>\r
14316 <member name="P:NAnt.Contrib.Types.Assembly.Unless">\r
14317 <summary>\r
14318 Opposite of <see cref="P:NAnt.Contrib.Types.Assembly.If"/>. If <c>false</c> then the assembly will be included. The default is\r
14319 <c>false</c>.\r
14320 </summary>\r
14321 </member>\r
14322 <member name="P:NAnt.Contrib.Types.Assembly.Version">\r
14323 <summary>\r
14324 The version of the assembly.\r
14325 </summary>\r
14326 </member>\r
14327 <member name="T:NAnt.Contrib.Types.AssemblySet">\r
14328 <summary>\r
14329 Represents a set of assemblies via their identity information.\r
14330 </summary>\r
14331 </member>\r
14332 <member name="F:NAnt.Contrib.Types.AssemblySet._assemblyCollection">\r
14333 <see cref="P:NAnt.Contrib.Types.AssemblySet.AssemblyCollection"/>\r
14334 </member>\r
14335 <member name="M:NAnt.Contrib.Types.AssemblySet.#ctor">\r
14336 <summary>\r
14337 Constructs and initializes an instance of <c>AssemblySet</c>.\r
14338 </summary>\r
14339 </member>\r
14340 <member name="P:NAnt.Contrib.Types.AssemblySet.AssemblyCollection">\r
14341 <summary>\r
14342 Gets the collection of assemblies added to this assembly set.\r
14343 </summary>\r
14344 </member>\r
14345 <member name="P:NAnt.Contrib.Types.AssemblySet.Assemblies">\r
14346 <summary>\r
14347 The assemblies to include.\r
14348 </summary>\r
14349 </member>\r
14350 <member name="P:NAnt.Contrib.Types.CodeStatsCount.FileSet">\r
14351 <summary>\r
14352 The set of files to work on.\r
14353 </summary>\r
14354 </member>\r
14355 <member name="P:NAnt.Contrib.Types.CodeStatsCount.Label">\r
14356 <summary>\r
14357 The label to apply to the results.\r
14358 </summary>\r
14359 </member>\r
14360 <member name="T:NAnt.Contrib.Types.CodeStatsCountCollection">\r
14361 <summary>\r
14362 Contains a collection of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements.\r
14363 </summary>\r
14364 </member>\r
14365 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor">\r
14366 <summary>\r
14367 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class.\r
14368 </summary>\r
14369 </member>\r
14370 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor(NAnt.Contrib.Types.CodeStatsCountCollection)">\r
14371 <summary>\r
14372 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class\r
14373 with the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> instance.\r
14374 </summary>\r
14375 </member>\r
14376 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor(NAnt.Contrib.Types.CodeStatsCount[])">\r
14377 <summary>\r
14378 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class\r
14379 with the specified array of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> instances.\r
14380 </summary>\r
14381 </member>\r
14382 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Add(NAnt.Contrib.Types.CodeStatsCount)">\r
14383 <summary>\r
14384 Adds a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to the end of the collection.\r
14385 </summary>\r
14386 <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to be added to the end of the collection.</param> \r
14387 <returns>The position into which the new element was inserted.</returns>\r
14388 </member>\r
14389 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.AddRange(NAnt.Contrib.Types.CodeStatsCount[])">\r
14390 <summary>\r
14391 Adds the elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> array to the end of the collection.\r
14392 </summary>\r
14393 <param name="items">The array of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements to be added to the end of the collection.</param> \r
14394 </member>\r
14395 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.AddRange(NAnt.Contrib.Types.CodeStatsCountCollection)">\r
14396 <summary>\r
14397 Adds the elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> to the end of the collection.\r
14398 </summary>\r
14399 <param name="items">The <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> to be added to the end of the collection.</param> \r
14400 </member>\r
14401 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Contains(NAnt.Contrib.Types.CodeStatsCount)">\r
14402 <summary>\r
14403 Determines whether a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> is in the collection.\r
14404 </summary>\r
14405 <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to locate in the collection.</param> \r
14406 <returns>\r
14407 <see langword="true"/> if <paramref name="item"/> is found in the \r
14408 collection; otherwise, <see langword="false"/>.\r
14409 </returns>\r
14410 </member>\r
14411 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Contains(System.String)">\r
14412 <summary>\r
14413 Determines whether a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with the specified\r
14414 value is in the collection.\r
14415 </summary>\r
14416 <param name="value">The argument value to locate in the collection.</param> \r
14417 <returns>\r
14418 <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with \r
14419 value <paramref name="value"/> is found in the collection; otherwise, \r
14420 <see langword="false"/>.\r
14421 </returns>\r
14422 </member>\r
14423 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.CopyTo(NAnt.Contrib.Types.CodeStatsCount[],System.Int32)">\r
14424 <summary>\r
14425 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. \r
14426 </summary>\r
14427 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> \r
14428 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>\r
14429 </member>\r
14430 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.IndexOf(NAnt.Contrib.Types.CodeStatsCount)">\r
14431 <summary>\r
14432 Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> object in the collection.\r
14433 </summary>\r
14434 <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> object for which the index is returned.</param> \r
14435 <returns>\r
14436 The index of the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/>. If the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> is not currently a member of the collection, it returns -1.\r
14437 </returns>\r
14438 </member>\r
14439 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Insert(System.Int32,NAnt.Contrib.Types.CodeStatsCount)">\r
14440 <summary>\r
14441 Inserts a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> into the collection at the specified index.\r
14442 </summary>\r
14443 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>\r
14444 <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to insert.</param>\r
14445 </member>\r
14446 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.GetEnumerator">\r
14447 <summary>\r
14448 Returns an enumerator that can iterate through the collection.\r
14449 </summary>\r
14450 <returns>\r
14451 A <see cref="T:NAnt.Contrib.Types.CodeStatsCountEnumerator"/> for the entire collection.\r
14452 </returns>\r
14453 </member>\r
14454 <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Remove(NAnt.Contrib.Types.CodeStatsCount)">\r
14455 <summary>\r
14456 Removes a member from the collection.\r
14457 </summary>\r
14458 <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to remove from the collection.</param>\r
14459 </member>\r
14460 <member name="P:NAnt.Contrib.Types.CodeStatsCountCollection.Item(System.Int32)">\r
14461 <summary>\r
14462 Gets or sets the element at the specified index.\r
14463 </summary>\r
14464 <param name="index">The zero-based index of the element to get or set.</param>\r
14465 </member>\r
14466 <member name="P:NAnt.Contrib.Types.CodeStatsCountCollection.Item(System.String)">\r
14467 <summary>\r
14468 Gets the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with the specified name.\r
14469 </summary>\r
14470 <param name="value">The name of the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to get.</param>\r
14471 </member>\r
14472 <member name="T:NAnt.Contrib.Types.CodeStatsCountEnumerator">\r
14473 <summary>\r
14474 Enumerates the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/>.\r
14475 </summary>\r
14476 </member>\r
14477 <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.#ctor(NAnt.Contrib.Types.CodeStatsCountCollection)">\r
14478 <summary>\r
14479 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountEnumerator"/> class\r
14480 with the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/>.\r
14481 </summary>\r
14482 <param name="arguments">The collection that should be enumerated.</param>\r
14483 </member>\r
14484 <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.MoveNext">\r
14485 <summary>\r
14486 Advances the enumerator to the next element of the collection.\r
14487 </summary>\r
14488 <returns>\r
14489 <see langword="true" /> if the enumerator was successfully advanced \r
14490 to the next element; <see langword="false" /> if the enumerator has \r
14491 passed the end of the collection.\r
14492 </returns>\r
14493 </member>\r
14494 <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.Reset">\r
14495 <summary>\r
14496 Sets the enumerator to its initial position, which is before the \r
14497 first element in the collection.\r
14498 </summary>\r
14499 </member>\r
14500 <member name="P:NAnt.Contrib.Types.CodeStatsCountEnumerator.Current">\r
14501 <summary>\r
14502 Gets the current element in the collection.\r
14503 </summary>\r
14504 <returns>\r
14505 The current element in the collection.\r
14506 </returns>\r
14507 </member>\r
14508 <member name="T:NAnt.Contrib.Types.Filter">\r
14509 <summary>\r
14510 Individual filter component of <see cref="T:NAnt.Contrib.Types.FilterSet"/>.\r
14511 </summary>\r
14512 </member>\r
14513 <member name="F:NAnt.Contrib.Types.Filter._token">\r
14514 <summary>\r
14515 Holds the token which will be replaced in the filter operation.\r
14516 </summary>\r
14517 </member>\r
14518 <member name="F:NAnt.Contrib.Types.Filter._value">\r
14519 <summary>\r
14520 Holsd the value which will replace the token in the filtering operation.\r
14521 </summary>\r
14522 </member>\r
14523 <member name="M:NAnt.Contrib.Types.Filter.#ctor">\r
14524 <summary>\r
14525 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.Filter"/> class.\r
14526 </summary>\r
14527 </member>\r
14528 <member name="M:NAnt.Contrib.Types.Filter.#ctor(System.String,System.String)">\r
14529 <summary>\r
14530 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.Filter"/> class with\r
14531 the given token and value.\r
14532 </summary>\r
14533 <param name="token">The token which will be replaced when filtering.</param>\r
14534 <param name="value">The value which will replace the token when filtering.</param>\r
14535 </member>\r
14536 <member name="P:NAnt.Contrib.Types.Filter.Token">\r
14537 <summary>\r
14538 The token which will be replaced when filtering.\r
14539 </summary>\r
14540 </member>\r
14541 <member name="P:NAnt.Contrib.Types.Filter.Value">\r
14542 <summary>\r
14543 The value which will replace the token when filtering.\r
14544 </summary>\r
14545 </member>\r
14546 <member name="T:NAnt.Contrib.Types.FilterCollection">\r
14547 <summary>\r
14548 Contains a collection of <see cref="T:NAnt.Contrib.Types.Filter"/> elements.\r
14549 </summary>\r
14550 </member>\r
14551 <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor">\r
14552 <summary>\r
14553 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class.\r
14554 </summary>\r
14555 </member>\r
14556 <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor(NAnt.Contrib.Types.FilterCollection)">\r
14557 <summary>\r
14558 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class\r
14559 with the specified <see cref="T:NAnt.Contrib.Types.FilterCollection"/> instance.\r
14560 </summary>\r
14561 </member>\r
14562 <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor(NAnt.Contrib.Types.Filter[])">\r
14563 <summary>\r
14564 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class\r
14565 with the specified array of <see cref="T:NAnt.Contrib.Types.Filter"/> instances.\r
14566 </summary>\r
14567 </member>\r
14568 <member name="M:NAnt.Contrib.Types.FilterCollection.Add(NAnt.Contrib.Types.Filter)">\r
14569 <summary>\r
14570 Adds a <see cref="T:NAnt.Contrib.Types.Filter"/> to the end of the collection.\r
14571 </summary>\r
14572 <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to be added to the end of the collection.</param> \r
14573 <returns>The position into which the new element was inserted.</returns>\r
14574 </member>\r
14575 <member name="M:NAnt.Contrib.Types.FilterCollection.AddRange(NAnt.Contrib.Types.Filter[])">\r
14576 <summary>\r
14577 Adds the elements of a <see cref="T:NAnt.Contrib.Types.Filter"/> array to the end of the collection.\r
14578 </summary>\r
14579 <param name="items">The array of <see cref="T:NAnt.Contrib.Types.Filter"/> elements to be added to the end of the collection.</param> \r
14580 </member>\r
14581 <member name="M:NAnt.Contrib.Types.FilterCollection.AddRange(NAnt.Contrib.Types.FilterCollection)">\r
14582 <summary>\r
14583 Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterCollection"/> to the end of the collection.\r
14584 </summary>\r
14585 <param name="items">The <see cref="T:NAnt.Contrib.Types.FilterCollection"/> to be added to the end of the collection.</param> \r
14586 </member>\r
14587 <member name="M:NAnt.Contrib.Types.FilterCollection.Contains(NAnt.Contrib.Types.Filter)">\r
14588 <summary>\r
14589 Determines whether a <see cref="T:NAnt.Contrib.Types.Filter"/> is in the collection.\r
14590 </summary>\r
14591 <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to locate in the collection.</param> \r
14592 <returns>\r
14593 <see langword="true"/> if <paramref name="item"/> is found in the \r
14594 collection; otherwise, <see langword="false"/>.\r
14595 </returns>\r
14596 </member>\r
14597 <member name="M:NAnt.Contrib.Types.FilterCollection.Contains(System.String)">\r
14598 <summary>\r
14599 Determines whether a <see cref="T:NAnt.Contrib.Types.Filter"/> with the specified\r
14600 token is in the collection.\r
14601 </summary>\r
14602 <param name="token">The token to locate in the collection.</param> \r
14603 <returns>\r
14604 <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.Filter"/> with the given \r
14605 token is found in the collection; otherwise, <see langword="false"/>.\r
14606 </returns>\r
14607 </member>\r
14608 <member name="M:NAnt.Contrib.Types.FilterCollection.CopyTo(NAnt.Contrib.Types.Filter[],System.Int32)">\r
14609 <summary>\r
14610 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. \r
14611 </summary>\r
14612 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> \r
14613 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>\r
14614 </member>\r
14615 <member name="M:NAnt.Contrib.Types.FilterCollection.IndexOf(NAnt.Contrib.Types.Filter)">\r
14616 <summary>\r
14617 Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.Filter"/> object in the collection.\r
14618 </summary>\r
14619 <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> object for which the index is returned.</param> \r
14620 <returns>\r
14621 The index of the specified <see cref="T:NAnt.Contrib.Types.Filter"/>. If the <see cref="T:NAnt.Contrib.Types.Filter"/> is not currently a member of the collection, it returns -1.\r
14622 </returns>\r
14623 </member>\r
14624 <member name="M:NAnt.Contrib.Types.FilterCollection.Insert(System.Int32,NAnt.Contrib.Types.Filter)">\r
14625 <summary>\r
14626 Inserts a <see cref="T:NAnt.Contrib.Types.Filter"/> into the collection at the specified index.\r
14627 </summary>\r
14628 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>\r
14629 <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to insert.</param>\r
14630 </member>\r
14631 <member name="M:NAnt.Contrib.Types.FilterCollection.GetEnumerator">\r
14632 <summary>\r
14633 Returns an enumerator that can iterate through the collection.\r
14634 </summary>\r
14635 <returns>\r
14636 A <see cref="T:NAnt.Contrib.Types.FilterEnumerator"/> for the entire collection.\r
14637 </returns>\r
14638 </member>\r
14639 <member name="M:NAnt.Contrib.Types.FilterCollection.Remove(NAnt.Contrib.Types.Filter)">\r
14640 <summary>\r
14641 Removes a member from the collection.\r
14642 </summary>\r
14643 <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to remove from the collection.</param>\r
14644 </member>\r
14645 <member name="P:NAnt.Contrib.Types.FilterCollection.Item(System.Int32)">\r
14646 <summary>\r
14647 Gets or sets the element at the specified index.\r
14648 </summary>\r
14649 <param name="index">The zero-based index of the element to get or set.</param>\r
14650 </member>\r
14651 <member name="P:NAnt.Contrib.Types.FilterCollection.Item(System.String)">\r
14652 <summary>\r
14653 Gets the <see cref="T:NAnt.Contrib.Types.Filter"/> with the specified token.\r
14654 </summary>\r
14655 <param name="token">The token to get.</param>\r
14656 </member>\r
14657 <member name="T:NAnt.Contrib.Types.FilterEnumerator">\r
14658 <summary>\r
14659 Enumerates the <see cref="T:NAnt.Contrib.Types.Filter"/> elements of a <see cref="T:NAnt.Contrib.Types.FilterCollection"/>.\r
14660 </summary>\r
14661 </member>\r
14662 <member name="M:NAnt.Contrib.Types.FilterEnumerator.#ctor(NAnt.Contrib.Types.FilterCollection)">\r
14663 <summary>\r
14664 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterEnumerator"/> class\r
14665 with the specified <see cref="T:NAnt.Contrib.Types.FilterCollection"/>.\r
14666 </summary>\r
14667 <param name="arguments">The collection that should be enumerated.</param>\r
14668 </member>\r
14669 <member name="M:NAnt.Contrib.Types.FilterEnumerator.MoveNext">\r
14670 <summary>\r
14671 Advances the enumerator to the next element of the collection.\r
14672 </summary>\r
14673 <returns>\r
14674 <see langword="true" /> if the enumerator was successfully advanced \r
14675 to the next element; <see langword="false" /> if the enumerator has \r
14676 passed the end of the collection.\r
14677 </returns>\r
14678 </member>\r
14679 <member name="M:NAnt.Contrib.Types.FilterEnumerator.Reset">\r
14680 <summary>\r
14681 Sets the enumerator to its initial position, which is before the \r
14682 first element in the collection.\r
14683 </summary>\r
14684 </member>\r
14685 <member name="P:NAnt.Contrib.Types.FilterEnumerator.Current">\r
14686 <summary>\r
14687 Gets the current element in the collection.\r
14688 </summary>\r
14689 <returns>\r
14690 The current element in the collection.\r
14691 </returns>\r
14692 </member>\r
14693 <member name="T:NAnt.Contrib.Types.FilterSet">\r
14694 <summary>\r
14695 A set of filters to be applied to something.\r
14696 </summary>\r
14697 <remarks>\r
14698 <para>\r
14699 A filter set may have begintoken and endtokens defined.\r
14700 </para>\r
14701 </remarks>\r
14702 </member>\r
14703 <member name="F:NAnt.Contrib.Types.FilterSet.DefaultTokenStart">\r
14704 <summary>\r
14705 The default token start string.\r
14706 </summary>\r
14707 </member>\r
14708 <member name="F:NAnt.Contrib.Types.FilterSet.DefaultTokenEnd">\r
14709 <summary>\r
14710 The default token end string.\r
14711 </summary>\r
14712 </member>\r
14713 <member name="M:NAnt.Contrib.Types.FilterSet.#ctor">\r
14714 <summary>\r
14715 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSet"/> class.\r
14716 </summary>\r
14717 </member>\r
14718 <member name="M:NAnt.Contrib.Types.FilterSet.ReplaceTokens(System.String)">\r
14719 <summary>\r
14720 Does replacement on the given string with token matching.\r
14721 </summary>\r
14722 <param name="line">The line to process the tokens in.</param>\r
14723 <returns>\r
14724 The line with the tokens replaced.\r
14725 </returns>\r
14726 </member>\r
14727 <member name="P:NAnt.Contrib.Types.FilterSet.BeginToken">\r
14728 <summary>\r
14729 The string used to identity the beginning of a token. The default is\r
14730 <c>@</c>.\r
14731 </summary>\r
14732 </member>\r
14733 <member name="P:NAnt.Contrib.Types.FilterSet.EndToken">\r
14734 <summary>\r
14735 The string used to identify the end of a token. The default is\r
14736 <c>@</c>.\r
14737 </summary>\r
14738 </member>\r
14739 <member name="P:NAnt.Contrib.Types.FilterSet.Filters">\r
14740 <summary>\r
14741 The filters to apply.\r
14742 </summary>\r
14743 </member>\r
14744 <member name="T:NAnt.Contrib.Types.FilterSetCollection">\r
14745 <summary>\r
14746 Contains a collection of <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements.\r
14747 </summary>\r
14748 </member>\r
14749 <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor">\r
14750 <summary>\r
14751 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class.\r
14752 </summary>\r
14753 </member>\r
14754 <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor(NAnt.Contrib.Types.FilterSetCollection)">\r
14755 <summary>\r
14756 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class\r
14757 with the specified <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> instance.\r
14758 </summary>\r
14759 </member>\r
14760 <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor(NAnt.Contrib.Types.FilterSet[])">\r
14761 <summary>\r
14762 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class\r
14763 with the specified array of <see cref="T:NAnt.Contrib.Types.FilterSet"/> instances.\r
14764 </summary>\r
14765 </member>\r
14766 <member name="M:NAnt.Contrib.Types.FilterSetCollection.Add(NAnt.Contrib.Types.FilterSet)">\r
14767 <summary>\r
14768 Adds a <see cref="T:NAnt.Contrib.Types.FilterSet"/> to the end of the collection.\r
14769 </summary>\r
14770 <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to be added to the end of the collection.</param> \r
14771 <returns>The position into which the new element was inserted.</returns>\r
14772 </member>\r
14773 <member name="M:NAnt.Contrib.Types.FilterSetCollection.AddRange(NAnt.Contrib.Types.FilterSet[])">\r
14774 <summary>\r
14775 Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterSet"/> array to the end of the collection.\r
14776 </summary>\r
14777 <param name="items">The array of <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements to be added to the end of the collection.</param> \r
14778 </member>\r
14779 <member name="M:NAnt.Contrib.Types.FilterSetCollection.AddRange(NAnt.Contrib.Types.FilterSetCollection)">\r
14780 <summary>\r
14781 Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> to the end of the collection.\r
14782 </summary>\r
14783 <param name="items">The <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> to be added to the end of the collection.</param> \r
14784 </member>\r
14785 <member name="M:NAnt.Contrib.Types.FilterSetCollection.Contains(NAnt.Contrib.Types.FilterSet)">\r
14786 <summary>\r
14787 Determines whether a <see cref="T:NAnt.Contrib.Types.FilterSet"/> is in the collection.\r
14788 </summary>\r
14789 <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to locate in the collection.</param> \r
14790 <returns>\r
14791 <see langword="true"/> if <paramref name="item"/> is found in the \r
14792 collection; otherwise, <see langword="false"/>.\r
14793 </returns>\r
14794 </member>\r
14795 <member name="M:NAnt.Contrib.Types.FilterSetCollection.CopyTo(NAnt.Contrib.Types.FilterSet[],System.Int32)">\r
14796 <summary>\r
14797 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. \r
14798 </summary>\r
14799 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> \r
14800 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>\r
14801 </member>\r
14802 <member name="M:NAnt.Contrib.Types.FilterSetCollection.IndexOf(NAnt.Contrib.Types.FilterSet)">\r
14803 <summary>\r
14804 Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.FilterSet"/> object in the collection.\r
14805 </summary>\r
14806 <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> object for which the index is returned.</param> \r
14807 <returns>\r
14808 The index of the specified <see cref="T:NAnt.Contrib.Types.FilterSet"/>. If the <see cref="T:NAnt.Contrib.Types.FilterSet"/> is not currently a member of the collection, it returns -1.\r
14809 </returns>\r
14810 </member>\r
14811 <member name="M:NAnt.Contrib.Types.FilterSetCollection.Insert(System.Int32,NAnt.Contrib.Types.FilterSet)">\r
14812 <summary>\r
14813 Inserts a <see cref="T:NAnt.Contrib.Types.FilterSet"/> into the collection at the specified index.\r
14814 </summary>\r
14815 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>\r
14816 <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to insert.</param>\r
14817 </member>\r
14818 <member name="M:NAnt.Contrib.Types.FilterSetCollection.GetEnumerator">\r
14819 <summary>\r
14820 Returns an enumerator that can iterate through the collection.\r
14821 </summary>\r
14822 <returns>\r
14823 A <see cref="T:NAnt.Contrib.Types.FilterSetEnumerator"/> for the entire collection.\r
14824 </returns>\r
14825 </member>\r
14826 <member name="M:NAnt.Contrib.Types.FilterSetCollection.Remove(NAnt.Contrib.Types.FilterSet)">\r
14827 <summary>\r
14828 Removes a member from the collection.\r
14829 </summary>\r
14830 <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to remove from the collection.</param>\r
14831 </member>\r
14832 <member name="M:NAnt.Contrib.Types.FilterSetCollection.ReplaceTokens(System.String)">\r
14833 <summary>\r
14834 Does replacement on the given string with token matching.\r
14835 </summary>\r
14836 <param name="line">The line to process the tokens in.</param>\r
14837 <returns>\r
14838 The line with the tokens replaced.\r
14839 </returns>\r
14840 </member>\r
14841 <member name="M:NAnt.Contrib.Types.FilterSetCollection.HasFilters">\r
14842 <summary>\r
14843 Checks to see if there are filters in the collection of filtersets.\r
14844 </summary>\r
14845 <returns>\r
14846 <see langword="true" /> if there are filters in this collection of\r
14847 filtersets; otherwise, <see langword="false" />.\r
14848 </returns>\r
14849 </member>\r
14850 <member name="P:NAnt.Contrib.Types.FilterSetCollection.Item(System.Int32)">\r
14851 <summary>\r
14852 Gets or sets the element at the specified index.\r
14853 </summary>\r
14854 <param name="index">The zero-based index of the element to get or set.</param>\r
14855 </member>\r
14856 <member name="T:NAnt.Contrib.Types.FilterSetEnumerator">\r
14857 <summary>\r
14858 Enumerates the <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements of a <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.\r
14859 </summary>\r
14860 </member>\r
14861 <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.#ctor(NAnt.Contrib.Types.FilterSetCollection)">\r
14862 <summary>\r
14863 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetEnumerator"/> class\r
14864 with the specified <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.\r
14865 </summary>\r
14866 <param name="arguments">The collection that should be enumerated.</param>\r
14867 </member>\r
14868 <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.MoveNext">\r
14869 <summary>\r
14870 Advances the enumerator to the next element of the collection.\r
14871 </summary>\r
14872 <returns>\r
14873 <see langword="true" /> if the enumerator was successfully advanced \r
14874 to the next element; <see langword="false" /> if the enumerator has \r
14875 passed the end of the collection.\r
14876 </returns>\r
14877 </member>\r
14878 <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.Reset">\r
14879 <summary>\r
14880 Sets the enumerator to its initial position, which is before the \r
14881 first element in the collection.\r
14882 </summary>\r
14883 </member>\r
14884 <member name="P:NAnt.Contrib.Types.FilterSetEnumerator.Current">\r
14885 <summary>\r
14886 Gets the current element in the collection.\r
14887 </summary>\r
14888 <returns>\r
14889 The current element in the collection.\r
14890 </returns>\r
14891 </member>\r
14892 <member name="T:NAnt.Contrib.Types.GacReference">\r
14893 <summary>\r
14894 Used to specify reference information when working with the GAC.\r
14895 </summary>\r
14896 <remarks>\r
14897 <para>\r
14898 The full details of GAC references can be found in the SDK documentation.\r
14899 </para>\r
14900 </remarks>\r
14901 </member>\r
14902 <member name="F:NAnt.Contrib.Types.GacReference._if">\r
14903 <summary>\r
14904 See <see cref="P:NAnt.Contrib.Types.GacReference.If"/>.\r
14905 </summary>\r
14906 </member>\r
14907 <member name="F:NAnt.Contrib.Types.GacReference._unless">\r
14908 <summary>\r
14909 See <see cref="P:NAnt.Contrib.Types.GacReference.Unless"/>.\r
14910 </summary>\r
14911 </member>\r
14912 <member name="F:NAnt.Contrib.Types.GacReference._schemeType">\r
14913 <summary>\r
14914 See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeType"/>.\r
14915 </summary>\r
14916 </member>\r
14917 <member name="F:NAnt.Contrib.Types.GacReference._schemeId">\r
14918 <summary>\r
14919 See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeId"/>.\r
14920 </summary>\r
14921 </member>\r
14922 <member name="F:NAnt.Contrib.Types.GacReference._schemeDescription">\r
14923 <summary>\r
14924 See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeDescription"/>.\r
14925 </summary>\r
14926 </member>\r
14927 <member name="M:NAnt.Contrib.Types.GacReference.#ctor">\r
14928 <summary>\r
14929 Constructs and initializes an instance of <c>GacReference</c>.\r
14930 </summary>\r
14931 </member>\r
14932 <member name="P:NAnt.Contrib.Types.GacReference.If">\r
14933 <summary>\r
14934 If <c>true</c> then the entity will be included. The default is <c>true</c>.\r
14935 </summary>\r
14936 </member>\r
14937 <member name="P:NAnt.Contrib.Types.GacReference.SchemeType">\r
14938 <summary>\r
14939 The scheme type to use when working with GAC references. The default \r
14940 is <see cref="F:SchemeType.None" />, which means that references will \r
14941 not be used by the GAC task.\r
14942 </summary>\r
14943 </member>\r
14944 <member name="P:NAnt.Contrib.Types.GacReference.SchemeId">\r
14945 <summary>\r
14946 The scheme ID to use when working with GAC references. This is only \r
14947 relevant if a scheme type other than <see cref="F:SchemeType.None" />\r
14948 is specified.\r
14949 </summary>\r
14950 </member>\r
14951 <member name="P:NAnt.Contrib.Types.GacReference.SchemeDescription">\r
14952 <summary>\r
14953 The scheme description to use when working with GAC references. This \r
14954 is only relevant if a scheme type other than <see cref="F:SchemeType.None" />\r
14955 is specified.\r
14956 </summary>\r
14957 </member>\r
14958 <member name="P:NAnt.Contrib.Types.GacReference.Unless">\r
14959 <summary>\r
14960 Opposite of <see cref="P:NAnt.Contrib.Types.GacReference.If"/>. If <c>false</c> then the entity will be included. The default is\r
14961 <c>false</c>.\r
14962 </summary>\r
14963 </member>\r
14964 <member name="T:NAnt.Contrib.Types.SchemaElement">\r
14965 <summary>\r
14966 Represents the an element based on a schema definition.\r
14967 </summary>\r
14968 </member>\r
14969 <member name="T:NAnt.Contrib.Types.XmlSchemaReference">\r
14970 <summary>\r
14971 Represents the schema collection element.\r
14972 </summary>\r
14973 </member>\r
14974 <member name="P:NAnt.Contrib.Types.XmlSchemaReference.Namespace">\r
14975 <summary>\r
14976 Namespace URI associated with this schema. \r
14977 If not present, it is assumed that the \r
14978 schema's targetNamespace value is to be used.\r
14979 </summary>\r
14980 </member>\r
14981 <member name="P:NAnt.Contrib.Types.XmlSchemaReference.Source">\r
14982 <summary>\r
14983 Location of this schema. Could be a \r
14984 local file path or an HTTP URL.\r
14985 </summary>\r
14986 </member>\r
14987 <member name="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection">\r
14988 <summary>\r
14989 Contains a collection of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements.\r
14990 </summary>\r
14991 </member>\r
14992 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor">\r
14993 <summary>\r
14994 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class.\r
14995 </summary>\r
14996 </member>\r
14997 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">\r
14998 <summary>\r
14999 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class\r
15000 with the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> instance.\r
15001 </summary>\r
15002 </member>\r
15003 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor(NAnt.Contrib.Types.XmlSchemaReference[])">\r
15004 <summary>\r
15005 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class\r
15006 with the specified array of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> instances.\r
15007 </summary>\r
15008 </member>\r
15009 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Add(NAnt.Contrib.Types.XmlSchemaReference)">\r
15010 <summary>\r
15011 Adds a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to the end of the collection.\r
15012 </summary>\r
15013 <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to be added to the end of the collection.</param> \r
15014 <returns>The position into which the new element was inserted.</returns>\r
15015 </member>\r
15016 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.AddRange(NAnt.Contrib.Types.XmlSchemaReference[])">\r
15017 <summary>\r
15018 Adds the elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> array to the end of the collection.\r
15019 </summary>\r
15020 <param name="items">The array of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements to be added to the end of the collection.</param> \r
15021 </member>\r
15022 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.AddRange(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">\r
15023 <summary>\r
15024 Adds the elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> to the end of the collection.\r
15025 </summary>\r
15026 <param name="items">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> to be added to the end of the collection.</param> \r
15027 </member>\r
15028 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Contains(NAnt.Contrib.Types.XmlSchemaReference)">\r
15029 <summary>\r
15030 Determines whether a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> is in the collection.\r
15031 </summary>\r
15032 <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to locate in the collection.</param> \r
15033 <returns>\r
15034 <see langword="true"/> if <paramref name="item"/> is found in the \r
15035 collection; otherwise, <see langword="false"/>.\r
15036 </returns>\r
15037 </member>\r
15038 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Contains(System.String)">\r
15039 <summary>\r
15040 Determines whether a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with the specified\r
15041 value is in the collection.\r
15042 </summary>\r
15043 <param name="value">The argument value to locate in the collection.</param> \r
15044 <returns>\r
15045 <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with \r
15046 value <paramref name="value"/> is found in the collection; otherwise, \r
15047 <see langword="false"/>.\r
15048 </returns>\r
15049 </member>\r
15050 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.CopyTo(NAnt.Contrib.Types.XmlSchemaReference[],System.Int32)">\r
15051 <summary>\r
15052 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. \r
15053 </summary>\r
15054 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> \r
15055 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>\r
15056 </member>\r
15057 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.IndexOf(NAnt.Contrib.Types.XmlSchemaReference)">\r
15058 <summary>\r
15059 Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> object in the collection.\r
15060 </summary>\r
15061 <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> object for which the index is returned.</param> \r
15062 <returns>\r
15063 The index of the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/>. If the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> is not currently a member of the collection, it returns -1.\r
15064 </returns>\r
15065 </member>\r
15066 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Insert(System.Int32,NAnt.Contrib.Types.XmlSchemaReference)">\r
15067 <summary>\r
15068 Inserts a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> into the collection at the specified index.\r
15069 </summary>\r
15070 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>\r
15071 <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to insert.</param>\r
15072 </member>\r
15073 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.GetEnumerator">\r
15074 <summary>\r
15075 Returns an enumerator that can iterate through the collection.\r
15076 </summary>\r
15077 <returns>\r
15078 A <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator"/> for the entire collection.\r
15079 </returns>\r
15080 </member>\r
15081 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Remove(NAnt.Contrib.Types.XmlSchemaReference)">\r
15082 <summary>\r
15083 Removes a member from the collection.\r
15084 </summary>\r
15085 <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to remove from the collection.</param>\r
15086 </member>\r
15087 <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Item(System.Int32)">\r
15088 <summary>\r
15089 Gets or sets the element at the specified index.\r
15090 </summary>\r
15091 <param name="index">The zero-based index of the element to get or set.</param>\r
15092 </member>\r
15093 <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Item(System.String)">\r
15094 <summary>\r
15095 Gets the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with the specified name.\r
15096 </summary>\r
15097 <param name="value">The name of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to get.</param>\r
15098 </member>\r
15099 <member name="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator">\r
15100 <summary>\r
15101 Enumerates the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/>.\r
15102 </summary>\r
15103 </member>\r
15104 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.#ctor(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">\r
15105 <summary>\r
15106 Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator"/> class\r
15107 with the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/>.\r
15108 </summary>\r
15109 <param name="arguments">The collection that should be enumerated.</param>\r
15110 </member>\r
15111 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.MoveNext">\r
15112 <summary>\r
15113 Advances the enumerator to the next element of the collection.\r
15114 </summary>\r
15115 <returns>\r
15116 <see langword="true" /> if the enumerator was successfully advanced \r
15117 to the next element; <see langword="false" /> if the enumerator has \r
15118 passed the end of the collection.\r
15119 </returns>\r
15120 </member>\r
15121 <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.Reset">\r
15122 <summary>\r
15123 Sets the enumerator to its initial position, which is before the \r
15124 first element in the collection.\r
15125 </summary>\r
15126 </member>\r
15127 <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.Current">\r
15128 <summary>\r
15129 Gets the current element in the collection.\r
15130 </summary>\r
15131 <returns>\r
15132 The current element in the collection.\r
15133 </returns>\r
15134 </member>\r
15135 <member name="T:NAnt.Contrib.Util.ChecksumHelper">\r
15136 <summary>\r
15137 Helper class to calculate checksums\r
15138 of files.\r
15139 </summary>\r
15140 </member>\r
15141 <member name="M:NAnt.Contrib.Util.ChecksumHelper.#ctor(System.String)">\r
15142 <summary>\r
15143 Create a new instance\r
15144 </summary>\r
15145 <param name="providerName">Name of hash algorithm to use</param>\r
15146 </member>\r
15147 <member name="M:NAnt.Contrib.Util.ChecksumHelper.CalculateChecksum(System.String)">\r
15148 <summary>\r
15149 Calculates a checksum for a given file\r
15150 and returns it in a hex string\r
15151 </summary>\r
15152 <param name="filename">name of the input file</param>\r
15153 <returns>hex checksum string</returns>\r
15154 </member>\r
15155 <member name="M:NAnt.Contrib.Util.ChecksumHelper.ChecksumToString(System.Byte[])">\r
15156 <summary>\r
15157 Converts a checksum value (a byte array)\r
15158 into a Hex-formatted string.\r
15159 </summary>\r
15160 <param name="checksum">Checksum value to convert</param>\r
15161 <returns>Hexified string value</returns>\r
15162 </member>\r
15163 <member name="T:NAnt.Contrib.Util.IRecorder">\r
15164 <summary>\r
15165 Recorder interface user with the Record task\r
15166 </summary>\r
15167 </member>\r
15168 <member name="M:NAnt.Contrib.Util.IRecorder.Start">\r
15169 <summary>\r
15170 Starts recording.\r
15171 </summary>\r
15172 </member>\r
15173 <member name="M:NAnt.Contrib.Util.IRecorder.Stop">\r
15174 <summary>\r
15175 Stops recording.\r
15176 </summary>\r
15177 </member>\r
15178 <member name="M:NAnt.Contrib.Util.IRecorder.Close">\r
15179 <summary>\r
15180 Closes the recorder.\r
15181 </summary>\r
15182 </member>\r
15183 <member name="M:NAnt.Contrib.Util.IRecorder.Flush">\r
15184 <summary>\r
15185 Flushes the recorder.\r
15186 </summary>\r
15187 </member>\r
15188 <member name="P:NAnt.Contrib.Util.IRecorder.Name">\r
15189 <summary>\r
15190 Gets the name of this recorder (possibly a file name).\r
15191 </summary>\r
15192 </member>\r
15193 <member name="P:NAnt.Contrib.Util.IRecorder.Logger">\r
15194 <summary>\r
15195 Gets The underlying <see cref="T:NAnt.Core.IBuildLogger"/> instance.\r
15196 </summary>\r
15197 </member>\r
15198 <member name="P:NAnt.Contrib.Util.IRecorder.AutoFlush">\r
15199 <summary>\r
15200 Defines whether the underlying writer is automatically flushes or \r
15201 not.\r
15202 </summary>\r
15203 </member>\r
15204 <member name="T:NAnt.Contrib.Util.RecorderCollection">\r
15205 <summary>\r
15206 Keeps track of used recorders\r
15207 </summary>\r
15208 </member>\r
15209 <member name="M:NAnt.Contrib.Util.FileLogListener.#ctor(System.String)">\r
15210 <summary>\r
15211 Initializes a new instance of the <see cref="T:NAnt.Contrib.Util.FileLogListener"/>\r
15212 class.\r
15213 </summary>\r
15214 </member>\r
15215 <member name="M:NAnt.Contrib.Util.FileLogListener.Flush">\r
15216 <summary>\r
15217 Flushes buffered build events or messages to the underlying storage.\r
15218 </summary>\r
15219 </member>\r
15220 <member name="M:NAnt.Contrib.Util.FileLogListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">\r
15221 <summary>\r
15222 Signals that a build has started.\r
15223 </summary>\r
15224 <param name="sender">The source of the event.</param>\r
15225 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>\r
15226 <remarks>\r
15227 This event is fired before any targets have started.\r
15228 </remarks>\r
15229 </member>\r
15230 <member name="M:NAnt.Contrib.Util.FileLogListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">\r
15231 <summary>\r
15232 Signals that the last target has finished.\r
15233 </summary>\r
15234 <param name="sender">The source of the event.</param>\r
15235 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>\r
15236 <remarks>\r
15237 This event will still be fired if an error occurred during the build.\r
15238 </remarks>\r
15239 </member>\r
15240 <member name="M:NAnt.Contrib.Util.FileLogListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">\r
15241 <summary>\r
15242 Signals that a target has started.\r
15243 </summary>\r
15244 <param name="sender">The source of the event.</param>\r
15245 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>\r
15246 </member>\r
15247 <member name="M:NAnt.Contrib.Util.FileLogListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">\r
15248 <summary>\r
15249 Signals that a task has finished.\r
15250 </summary>\r
15251 <param name="sender">The source of the event.</param>\r
15252 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>\r
15253 <remarks>\r
15254 This event will still be fired if an error occurred during the build.\r
15255 </remarks>\r
15256 </member>\r
15257 <member name="M:NAnt.Contrib.Util.FileLogListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">\r
15258 <summary>\r
15259 Signals that a task has started.\r
15260 </summary>\r
15261 <param name="sender">The source of the event.</param>\r
15262 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>\r
15263 </member>\r
15264 <member name="M:NAnt.Contrib.Util.FileLogListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">\r
15265 <summary>\r
15266 Signals that a task has finished.\r
15267 </summary>\r
15268 <param name="sender">The source of the event.</param>\r
15269 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>\r
15270 <remarks>\r
15271 This event will still be fired if an error occurred during the build.\r
15272 </remarks>\r
15273 </member>\r
15274 <member name="M:NAnt.Contrib.Util.FileLogListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">\r
15275 <summary>\r
15276 Signals that a message has been logged.\r
15277 </summary>\r
15278 <param name="sender">The source of the event.</param>\r
15279 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>\r
15280 <remarks>\r
15281 Only messages with a priority higher or equal to the threshold of\r
15282 the logger will actually be output in the build log.\r
15283 </remarks>\r
15284 </member>\r
15285 <member name="M:NAnt.Contrib.Util.FileLogListener.Log(System.String)">\r
15286 <summary>\r
15287 Empty implementation which allows derived classes to receive the\r
15288 output that is generated in this logger.\r
15289 </summary>\r
15290 <param name="message">The message being logged.</param>\r
15291 </member>\r
15292 <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">\r
15293 <summary>\r
15294 Outputs an indented message to the build log if its priority is \r
15295 greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the \r
15296 logger.\r
15297 </summary>\r
15298 <param name="messageLevel">The priority of the message to output.</param>\r
15299 <param name="message">The message to output.</param>\r
15300 <param name="indentationLength">The number of characters that the message should be indented.</param>\r
15301 </member>\r
15302 <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.BuildEventArgs)">\r
15303 <summary>\r
15304 Outputs an indented message to the build log if its priority is \r
15305 greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the \r
15306 logger.\r
15307 </summary>\r
15308 <param name="e">The event to output.</param>\r
15309 </member>\r
15310 <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">\r
15311 <summary>\r
15312 Outputs an indented message to the build log if its priority is \r
15313 greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the \r
15314 logger.\r
15315 </summary>\r
15316 <param name="e">The event to output.</param>\r
15317 <param name="indentationLength">TODO</param>\r
15318 </member>\r
15319 <member name="P:NAnt.Contrib.Util.FileLogListener.Threshold">\r
15320 <summary>\r
15321 Gets or sets the highest level of message this logger should respond\r
15322 to.\r
15323 </summary>\r
15324 <value>\r
15325 The highest level of message this logger should respond to.\r
15326 </value>\r
15327 <remarks>\r
15328 Only messages with a message level higher than or equal to the given\r
15329 level should be written to the log.\r
15330 </remarks>\r
15331 </member>\r
15332 <member name="P:NAnt.Contrib.Util.FileLogListener.EmacsMode">\r
15333 <summary>\r
15334 Gets or sets a value indicating whether to produce emacs (and other\r
15335 editor) friendly output.\r
15336 </summary>\r
15337 <value>\r
15338 <see langword="true" /> if output is to be unadorned so that emacs \r
15339 and other editors can parse files names, etc. The default is\r
15340 <see langword="false" />.\r
15341 </value>\r
15342 </member>\r
15343 <member name="P:NAnt.Contrib.Util.FileLogListener.OutputWriter">\r
15344 <summary>\r
15345 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is\r
15346 to send its output.\r
15347 </summary>\r
15348 </member>\r
15349 <member name="T:NAnt.Contrib.Util.FileUtils">\r
15350 <summary>\r
15351 Groups a set of useful file manipulation methods.\r
15352 </summary>\r
15353 </member>\r
15354 <member name="M:NAnt.Contrib.Util.FileUtils.#ctor">\r
15355 <summary>\r
15356 Initializes a new instance of the <see cref="T:NAnt.Contrib.Util.FileUtils"/> class.\r
15357 </summary>\r
15358 <remarks>\r
15359 Prevents instantiation of the <see cref="T:NAnt.Contrib.Util.FileUtils"/> class.\r
15360 </remarks>\r
15361 </member>\r
15362 <member name="M:NAnt.Contrib.Util.FileUtils.CopyFile(System.String,System.String,System.Text.Encoding,NAnt.Contrib.Types.FilterSetCollection)">\r
15363 <summary>\r
15364 Copies a file while replacing the tokens identified by the given\r
15365 <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.\r
15366 </summary>\r
15367 <param name="sourceFileName">The file to copy.</param>\r
15368 <param name="destinationFileName">The name of the destination file.</param>\r
15369 <param name="encoding">The <see cref="T:System.Text.Encoding"/> used when filter-copying the file.</param>\r
15370 <param name="filtersets">The collection of filtersets that should be applied to the file.</param>\r
15371 </member>\r
15372 <member name="M:NAnt.Contrib.Util.FileUtils.MoveFile(System.String,System.String,System.Text.Encoding,NAnt.Contrib.Types.FilterSetCollection)">\r
15373 <summary>\r
15374 Moves a file while replacing the tokens identified by the given\r
15375 <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.\r
15376 </summary>\r
15377 <param name="sourceFileName">The file to move.</param>\r
15378 <param name="destinationFileName">The name of the destination file.</param>\r
15379 <param name="encoding">The <see cref="T:System.Text.Encoding"/> used when filter-copying the file.</param>\r
15380 <param name="filtersets">The collection of filtersets that should be applied to the file.</param>\r
15381 </member>\r
15382 <member name="M:NAnt.Contrib.Util.FileUtils.GetRelativePath(System.String,System.String)">\r
15383 <summary>\r
15384 Given an absolute directory and an absolute file name, returns a \r
15385 relative file name.\r
15386 </summary>\r
15387 <param name="basePath">An absolute directory.</param>\r
15388 <param name="absolutePath">An absolute file name.</param>\r
15389 <returns>\r
15390 A relative file name for the given absolute file name.\r
15391 </returns>\r
15392 </member>\r
15393 <member name="T:NAnt.Contrib.Util.SqlHelper">\r
15394 <summary>\r
15395 Helper class used to execute Sql Statements.\r
15396 </summary>\r
15397 </member>\r
15398 <member name="M:NAnt.Contrib.Util.SqlHelper.#ctor(System.String,System.Boolean)">\r
15399 <summary>\r
15400 Initializes a new instance.\r
15401 </summary>\r
15402 <param name="connectionString">OleDB Connection string</param>\r
15403 <param name="useTransaction">True if you want to use a transaction</param>\r
15404 </member>\r
15405 <member name="M:NAnt.Contrib.Util.SqlHelper.Close(System.Boolean)">\r
15406 <summary>\r
15407 Close the connection and terminate\r
15408 </summary>\r
15409 <param name="commit">true if the transaction should be commited</param>\r
15410 </member>\r
15411 <member name="M:NAnt.Contrib.Util.SqlHelper.Execute(System.String,System.Int32)">\r
15412 <summary>\r
15413 Executes a SQL statement.\r
15414 </summary>\r
15415 <param name="sql">SQL statement to execute</param>\r
15416 <param name="cmdTimeout">Command timeout to use</param>\r
15417 <returns>Data reader used to check the result</returns>\r
15418 </member>\r
15419 <member name="P:NAnt.Contrib.Util.SqlHelper.Connection">\r
15420 <summary>\r
15421 OleDB Connection object\r
15422 </summary>\r
15423 </member>\r
15424 <member name="T:NAnt.Contrib.Util.SqlStatementAdapter">\r
15425 <summary>\r
15426 Helper class to adapt SQL statements from some\r
15427 input into something OLEDB can consume directly\r
15428 </summary>\r
15429 </member>\r
15430 <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.#ctor(NAnt.Contrib.Util.SqlStatementList)">\r
15431 <summary>\r
15432 Creates a new instance\r
15433 </summary>\r
15434 \r
15435 </member>\r
15436 <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.AdaptSql(System.String)">\r
15437 <summary>\r
15438 Adapts a set of Sql statements from a string.\r
15439 </summary>\r
15440 <param name="sql">A string containing the original sql statements</param>\r
15441 </member>\r
15442 <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.AdaptSqlFile(System.String)">\r
15443 <summary>\r
15444 Adapts a set of Sql statements from a string.\r
15445 </summary>\r
15446 <param name="file">Path of file containing all sql statements</param>\r
15447 <returns>The new instance</returns>\r
15448 </member>\r
15449 <member name="T:NAnt.Contrib.Util.DelimiterStyle">\r
15450 <summary>\r
15451 Determines how the delimiter is interpreted in a SQL string.\r
15452 </summary>\r
15453 </member>\r
15454 <member name="F:NAnt.Contrib.Util.DelimiterStyle.Normal">\r
15455 <summary>\r
15456 Delimiter can appear anywhere on a line.\r
15457 </summary>\r
15458 </member>\r
15459 <member name="F:NAnt.Contrib.Util.DelimiterStyle.Line">\r
15460 <summary>\r
15461 Delimiter always appears by itself on a line.\r
15462 </summary>\r
15463 </member>\r
15464 <member name="T:NAnt.Contrib.Util.SqlStatementList">\r
15465 <summary>\r
15466 Helper class to maintain a list of SQL Statements.\r
15467 </summary>\r
15468 </member>\r
15469 <member name="M:NAnt.Contrib.Util.SqlStatementList.#ctor(System.String,NAnt.Contrib.Util.DelimiterStyle)">\r
15470 <summary>\r
15471 Initializes a new instance.\r
15472 </summary>\r
15473 <param name="delimiter">String that separates statements from each other</param>\r
15474 <param name="style">Style of the delimiter</param>\r
15475 </member>\r
15476 <member name="M:NAnt.Contrib.Util.SqlStatementList.ParseSql(System.String)">\r
15477 <summary>\r
15478 Parses the SQL into the internal list using the specified delimiter\r
15479 and delimiter style\r
15480 </summary>\r
15481 <param name="sql">The SQL string to parse.</param>\r
15482 </member>\r
15483 <member name="M:NAnt.Contrib.Util.SqlStatementList.ParseSqlFromFile(System.String)">\r
15484 <summary>\r
15485 Parses the contents of the file into the \r
15486 internal list using the specified delimiter\r
15487 and delimiter style\r
15488 </summary>\r
15489 <param name="file">File name</param>\r
15490 </member>\r
15491 <member name="M:NAnt.Contrib.Util.SqlStatementList.GetEnumerator">\r
15492 <summary>\r
15493 Allows foreach().\r
15494 </summary>\r
15495 <returns></returns>\r
15496 </member>\r
15497 <member name="M:NAnt.Contrib.Util.SqlStatementList.StripComments(System.String)">\r
15498 <summary>\r
15499 Strips all single line comments \r
15500 in the specified sql\r
15501 </summary>\r
15502 <param name="sql"></param>\r
15503 <returns></returns>\r
15504 </member>\r
15505 <member name="M:NAnt.Contrib.Util.SqlStatementList.ExpandProps(System.String)">\r
15506 <summary>\r
15507 Expands project properties in the\r
15508 sql string\r
15509 </summary>\r
15510 <param name="sql"></param>\r
15511 <returns></returns>\r
15512 </member>\r
15513 <member name="P:NAnt.Contrib.Util.SqlStatementList.Count">\r
15514 <summary>\r
15515 Gets the number of statements in the list.\r
15516 </summary>\r
15517 </member>\r
15518 <member name="P:NAnt.Contrib.Util.SqlStatementList.Item(System.Int32)">\r
15519 <summary>\r
15520 Gets the statement specified by the index.\r
15521 </summary>\r
15522 </member>\r
15523 <member name="P:NAnt.Contrib.Util.SqlStatementList.Properties">\r
15524 <summary>\r
15525 Project's properties for property expansion\r
15526 </summary>\r
15527 </member>\r
15528 <member name="T:NAnt.Contrib.Schemas.Msi.msi">\r
15529 <remarks/>\r
15530 </member>\r
15531 <member name="T:NAnt.Contrib.Schemas.Msi.MSIBase">\r
15532 <remarks/>\r
15533 </member>\r
15534 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.summaryinformation">\r
15535 <remarks/>\r
15536 </member>\r
15537 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.properties">\r
15538 <remarks/>\r
15539 </member>\r
15540 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.search">\r
15541 <remarks/>\r
15542 </member>\r
15543 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.tables">\r
15544 <remarks/>\r
15545 </member>\r
15546 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.directories">\r
15547 <remarks/>\r
15548 </member>\r
15549 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.environment">\r
15550 <remarks/>\r
15551 </member>\r
15552 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.components">\r
15553 <remarks/>\r
15554 </member>\r
15555 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.dialogs">\r
15556 <remarks/>\r
15557 </member>\r
15558 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controls">\r
15559 <remarks/>\r
15560 </member>\r
15561 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controlconditions">\r
15562 <remarks/>\r
15563 </member>\r
15564 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controlevents">\r
15565 <remarks/>\r
15566 </member>\r
15567 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.registry">\r
15568 <remarks/>\r
15569 </member>\r
15570 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.icons">\r
15571 <remarks/>\r
15572 </member>\r
15573 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.shortcuts">\r
15574 <remarks/>\r
15575 </member>\r
15576 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.binaries">\r
15577 <remarks/>\r
15578 </member>\r
15579 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.customactions">\r
15580 <remarks/>\r
15581 </member>\r
15582 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.sequences">\r
15583 <remarks/>\r
15584 </member>\r
15585 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.actiontext">\r
15586 <remarks/>\r
15587 </member>\r
15588 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.appmappings">\r
15589 <remarks/>\r
15590 </member>\r
15591 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.urlproperties">\r
15592 <remarks/>\r
15593 </member>\r
15594 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.vdirproperties">\r
15595 <remarks/>\r
15596 </member>\r
15597 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.approots">\r
15598 <remarks/>\r
15599 </member>\r
15600 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.iisproperties">\r
15601 <remarks/>\r
15602 </member>\r
15603 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.output">\r
15604 <remarks/>\r
15605 </member>\r
15606 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.sourcedir">\r
15607 <remarks/>\r
15608 </member>\r
15609 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.template">\r
15610 <remarks/>\r
15611 </member>\r
15612 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.errortemplate">\r
15613 <remarks/>\r
15614 </member>\r
15615 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.verbose">\r
15616 <remarks/>\r
15617 </member>\r
15618 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.debug">\r
15619 <remarks/>\r
15620 </member>\r
15621 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.deterministicguids">\r
15622 <remarks/>\r
15623 </member>\r
15624 <member name="F:NAnt.Contrib.Schemas.Msi.msi.launchconditions">\r
15625 <remarks/>\r
15626 </member>\r
15627 <member name="F:NAnt.Contrib.Schemas.Msi.msi.features">\r
15628 <remarks/>\r
15629 </member>\r
15630 <member name="F:NAnt.Contrib.Schemas.Msi.msi.mergemodules">\r
15631 <remarks/>\r
15632 </member>\r
15633 <member name="F:NAnt.Contrib.Schemas.Msi.msi.license">\r
15634 <remarks/>\r
15635 </member>\r
15636 <member name="F:NAnt.Contrib.Schemas.Msi.msi.banner">\r
15637 <remarks/>\r
15638 </member>\r
15639 <member name="F:NAnt.Contrib.Schemas.Msi.msi.background">\r
15640 <remarks/>\r
15641 </member>\r
15642 <member name="T:NAnt.Contrib.Schemas.Msi.MSILaunchCondition">\r
15643 <remarks/>\r
15644 </member>\r
15645 <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.description">\r
15646 <remarks/>\r
15647 </member>\r
15648 <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.name">\r
15649 <remarks/>\r
15650 </member>\r
15651 <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.condition">\r
15652 <remarks/>\r
15653 </member>\r
15654 <member name="T:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem">\r
15655 <remarks/>\r
15656 </member>\r
15657 <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.module">\r
15658 <remarks/>\r
15659 </member>\r
15660 <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.name">\r
15661 <remarks/>\r
15662 </member>\r
15663 <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.value">\r
15664 <remarks/>\r
15665 </member>\r
15666 <member name="T:NAnt.Contrib.Schemas.Msi.MSIMerge">\r
15667 <remarks/>\r
15668 </member>\r
15669 <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.modules">\r
15670 <remarks/>\r
15671 </member>\r
15672 <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.configurationitems">\r
15673 <remarks/>\r
15674 </member>\r
15675 <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.feature">\r
15676 <remarks/>\r
15677 </member>\r
15678 <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSet">\r
15679 <remarks/>\r
15680 </member>\r
15681 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.include">\r
15682 <remarks/>\r
15683 </member>\r
15684 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.exclude">\r
15685 <remarks/>\r
15686 </member>\r
15687 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.includesfile">\r
15688 <remarks/>\r
15689 </member>\r
15690 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.excludesfile">\r
15691 <remarks/>\r
15692 </member>\r
15693 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.includes">\r
15694 <remarks/>\r
15695 </member>\r
15696 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.excludes">\r
15697 <remarks/>\r
15698 </member>\r
15699 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.basedir">\r
15700 <remarks/>\r
15701 </member>\r
15702 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.defaultexcludes">\r
15703 <remarks/>\r
15704 </member>\r
15705 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.failonempty">\r
15706 <remarks/>\r
15707 </member>\r
15708 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.refid">\r
15709 <remarks/>\r
15710 </member>\r
15711 <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern">\r
15712 <remarks/>\r
15713 </member>\r
15714 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.name">\r
15715 <remarks/>\r
15716 </member>\r
15717 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.frompath">\r
15718 <remarks/>\r
15719 </member>\r
15720 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.asIs">\r
15721 <remarks/>\r
15722 </member>\r
15723 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.asIsSpecified">\r
15724 <remarks/>\r
15725 </member>\r
15726 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.if">\r
15727 <remarks/>\r
15728 </member>\r
15729 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.unless">\r
15730 <remarks/>\r
15731 </member>\r
15732 <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile">\r
15733 <remarks/>\r
15734 </member>\r
15735 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.name">\r
15736 <remarks/>\r
15737 </member>\r
15738 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.if">\r
15739 <remarks/>\r
15740 </member>\r
15741 <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.unless">\r
15742 <remarks/>\r
15743 </member>\r
15744 <member name="T:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition">\r
15745 <remarks/>\r
15746 </member>\r
15747 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition.expression">\r
15748 <remarks/>\r
15749 </member>\r
15750 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition.level">\r
15751 <remarks/>\r
15752 </member>\r
15753 <member name="T:NAnt.Contrib.Schemas.Msi.MSIFeature">\r
15754 <remarks/>\r
15755 </member>\r
15756 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.description">\r
15757 <remarks/>\r
15758 </member>\r
15759 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.conditions">\r
15760 <remarks/>\r
15761 </member>\r
15762 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.feature">\r
15763 <remarks/>\r
15764 </member>\r
15765 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.name">\r
15766 <remarks/>\r
15767 </member>\r
15768 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.attr">\r
15769 <remarks/>\r
15770 </member>\r
15771 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.title">\r
15772 <remarks/>\r
15773 </member>\r
15774 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.display">\r
15775 <remarks/>\r
15776 </member>\r
15777 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.typical">\r
15778 <remarks/>\r
15779 </member>\r
15780 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.directory">\r
15781 <remarks/>\r
15782 </member>\r
15783 <member name="T:NAnt.Contrib.Schemas.Msi.MSIIISProperty">\r
15784 <remarks/>\r
15785 </member>\r
15786 <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.directory">\r
15787 <remarks/>\r
15788 </member>\r
15789 <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.attr">\r
15790 <remarks/>\r
15791 </member>\r
15792 <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.defaultdoc">\r
15793 <remarks/>\r
15794 </member>\r
15795 <member name="T:NAnt.Contrib.Schemas.Msi.MSIAppRoot">\r
15796 <remarks/>\r
15797 </member>\r
15798 <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.component">\r
15799 <remarks/>\r
15800 </member>\r
15801 <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.urlproperty">\r
15802 <remarks/>\r
15803 </member>\r
15804 <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.inprocflag">\r
15805 <remarks/>\r
15806 </member>\r
15807 <member name="T:NAnt.Contrib.Schemas.Msi.MSIVDirProperty">\r
15808 <remarks/>\r
15809 </member>\r
15810 <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.name">\r
15811 <remarks/>\r
15812 </member>\r
15813 <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.portproperty">\r
15814 <remarks/>\r
15815 </member>\r
15816 <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.urlproperty">\r
15817 <remarks/>\r
15818 </member>\r
15819 <member name="T:NAnt.Contrib.Schemas.Msi.MSIURLProperty">\r
15820 <remarks/>\r
15821 </member>\r
15822 <member name="F:NAnt.Contrib.Schemas.Msi.MSIURLProperty.name">\r
15823 <remarks/>\r
15824 </member>\r
15825 <member name="F:NAnt.Contrib.Schemas.Msi.MSIURLProperty.property">\r
15826 <remarks/>\r
15827 </member>\r
15828 <member name="T:NAnt.Contrib.Schemas.Msi.MSIAppMapping">\r
15829 <remarks/>\r
15830 </member>\r
15831 <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.directory">\r
15832 <remarks/>\r
15833 </member>\r
15834 <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.extension">\r
15835 <remarks/>\r
15836 </member>\r
15837 <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.exepath">\r
15838 <remarks/>\r
15839 </member>\r
15840 <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.verbs">\r
15841 <remarks/>\r
15842 </member>\r
15843 <member name="T:NAnt.Contrib.Schemas.Msi.MSIActionTextAction">\r
15844 <remarks/>\r
15845 </member>\r
15846 <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.description">\r
15847 <remarks/>\r
15848 </member>\r
15849 <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.name">\r
15850 <remarks/>\r
15851 </member>\r
15852 <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.template">\r
15853 <remarks/>\r
15854 </member>\r
15855 <member name="T:NAnt.Contrib.Schemas.Msi.MSISequence">\r
15856 <remarks/>\r
15857 </member>\r
15858 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.type">\r
15859 <remarks/>\r
15860 </member>\r
15861 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.action">\r
15862 <remarks/>\r
15863 </member>\r
15864 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.value">\r
15865 <remarks/>\r
15866 </member>\r
15867 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.condition">\r
15868 <remarks/>\r
15869 </member>\r
15870 <member name="T:NAnt.Contrib.Schemas.Msi.MSISequenceTable">\r
15871 <remarks/>\r
15872 </member>\r
15873 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.installexecute">\r
15874 <remarks/>\r
15875 </member>\r
15876 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.installui">\r
15877 <remarks/>\r
15878 </member>\r
15879 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.adminexecute">\r
15880 <remarks/>\r
15881 </member>\r
15882 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.adminui">\r
15883 <remarks/>\r
15884 </member>\r
15885 <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.advtexecute">\r
15886 <remarks/>\r
15887 </member>\r
15888 <member name="T:NAnt.Contrib.Schemas.Msi.MSICustomAction">\r
15889 <remarks/>\r
15890 </member>\r
15891 <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.action">\r
15892 <remarks/>\r
15893 </member>\r
15894 <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.type">\r
15895 <remarks/>\r
15896 </member>\r
15897 <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.source">\r
15898 <remarks/>\r
15899 </member>\r
15900 <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.target">\r
15901 <remarks/>\r
15902 </member>\r
15903 <member name="T:NAnt.Contrib.Schemas.Msi.MSIBinary">\r
15904 <remarks/>\r
15905 </member>\r
15906 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBinary.name">\r
15907 <remarks/>\r
15908 </member>\r
15909 <member name="F:NAnt.Contrib.Schemas.Msi.MSIBinary.value">\r
15910 <remarks/>\r
15911 </member>\r
15912 <member name="T:NAnt.Contrib.Schemas.Msi.MSIShortcut">\r
15913 <remarks/>\r
15914 </member>\r
15915 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.description">\r
15916 <remarks/>\r
15917 </member>\r
15918 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.name">\r
15919 <remarks/>\r
15920 </member>\r
15921 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.directory">\r
15922 <remarks/>\r
15923 </member>\r
15924 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.filename">\r
15925 <remarks/>\r
15926 </member>\r
15927 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.component">\r
15928 <remarks/>\r
15929 </member>\r
15930 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.target">\r
15931 <remarks/>\r
15932 </member>\r
15933 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.arguments">\r
15934 <remarks/>\r
15935 </member>\r
15936 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.hotkey">\r
15937 <remarks/>\r
15938 </member>\r
15939 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.icon">\r
15940 <remarks/>\r
15941 </member>\r
15942 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.iconindex">\r
15943 <remarks/>\r
15944 </member>\r
15945 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.iconindexSpecified">\r
15946 <remarks/>\r
15947 </member>\r
15948 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.showcmd">\r
15949 <remarks/>\r
15950 </member>\r
15951 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.showcmdSpecified">\r
15952 <remarks/>\r
15953 </member>\r
15954 <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.wkdir">\r
15955 <remarks/>\r
15956 </member>\r
15957 <member name="T:NAnt.Contrib.Schemas.Msi.MSIIcon">\r
15958 <remarks/>\r
15959 </member>\r
15960 <member name="F:NAnt.Contrib.Schemas.Msi.MSIIcon.name">\r
15961 <remarks/>\r
15962 </member>\r
15963 <member name="F:NAnt.Contrib.Schemas.Msi.MSIIcon.value">\r
15964 <remarks/>\r
15965 </member>\r
15966 <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue">\r
15967 <remarks/>\r
15968 </member>\r
15969 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.name">\r
15970 <remarks/>\r
15971 </member>\r
15972 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.value">\r
15973 <remarks/>\r
15974 </member>\r
15975 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.dword">\r
15976 <remarks/>\r
15977 </member>\r
15978 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.id">\r
15979 <remarks/>\r
15980 </member>\r
15981 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.Value">\r
15982 <remarks/>\r
15983 </member>\r
15984 <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKey">\r
15985 <remarks/>\r
15986 </member>\r
15987 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.value">\r
15988 <remarks/>\r
15989 </member>\r
15990 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.path">\r
15991 <remarks/>\r
15992 </member>\r
15993 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.root">\r
15994 <remarks/>\r
15995 </member>\r
15996 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.component">\r
15997 <remarks/>\r
15998 </member>\r
15999 <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot">\r
16000 <remarks/>\r
16001 </member>\r
16002 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.dependent">\r
16003 <remarks/>\r
16004 </member>\r
16005 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.machine">\r
16006 <remarks/>\r
16007 </member>\r
16008 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.classes">\r
16009 <remarks/>\r
16010 </member>\r
16011 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.users">\r
16012 <remarks/>\r
16013 </member>\r
16014 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.user">\r
16015 <remarks/>\r
16016 </member>\r
16017 <member name="T:NAnt.Contrib.Schemas.Msi.MSIControlEvent">\r
16018 <remarks/>\r
16019 </member>\r
16020 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.dialog">\r
16021 <remarks/>\r
16022 </member>\r
16023 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.control">\r
16024 <remarks/>\r
16025 </member>\r
16026 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.name">\r
16027 <remarks/>\r
16028 </member>\r
16029 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.argument">\r
16030 <remarks/>\r
16031 </member>\r
16032 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.condition">\r
16033 <remarks/>\r
16034 </member>\r
16035 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.order">\r
16036 <remarks/>\r
16037 </member>\r
16038 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.orderSpecified">\r
16039 <remarks/>\r
16040 </member>\r
16041 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.remove">\r
16042 <remarks/>\r
16043 </member>\r
16044 <member name="T:NAnt.Contrib.Schemas.Msi.MSIControlCondition">\r
16045 <remarks/>\r
16046 </member>\r
16047 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.dialog">\r
16048 <remarks/>\r
16049 </member>\r
16050 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.control">\r
16051 <remarks/>\r
16052 </member>\r
16053 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.action">\r
16054 <remarks/>\r
16055 </member>\r
16056 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.condition">\r
16057 <remarks/>\r
16058 </member>\r
16059 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.remove">\r
16060 <remarks/>\r
16061 </member>\r
16062 <member name="T:NAnt.Contrib.Schemas.Msi.MSIControl">\r
16063 <remarks/>\r
16064 </member>\r
16065 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.name">\r
16066 <remarks/>\r
16067 </member>\r
16068 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.dialog">\r
16069 <remarks/>\r
16070 </member>\r
16071 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.type">\r
16072 <remarks/>\r
16073 </member>\r
16074 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.x">\r
16075 <remarks/>\r
16076 </member>\r
16077 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.y">\r
16078 <remarks/>\r
16079 </member>\r
16080 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.width">\r
16081 <remarks/>\r
16082 </member>\r
16083 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.height">\r
16084 <remarks/>\r
16085 </member>\r
16086 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.attr">\r
16087 <remarks/>\r
16088 </member>\r
16089 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.property">\r
16090 <remarks/>\r
16091 </member>\r
16092 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.text">\r
16093 <remarks/>\r
16094 </member>\r
16095 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.nextcontrol">\r
16096 <remarks/>\r
16097 </member>\r
16098 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.help">\r
16099 <remarks/>\r
16100 </member>\r
16101 <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.remove">\r
16102 <remarks/>\r
16103 </member>\r
16104 <member name="T:NAnt.Contrib.Schemas.Msi.MSIDialog">\r
16105 <remarks/>\r
16106 </member>\r
16107 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.name">\r
16108 <remarks/>\r
16109 </member>\r
16110 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.hcenter">\r
16111 <remarks/>\r
16112 </member>\r
16113 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.vcenter">\r
16114 <remarks/>\r
16115 </member>\r
16116 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.width">\r
16117 <remarks/>\r
16118 </member>\r
16119 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.height">\r
16120 <remarks/>\r
16121 </member>\r
16122 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.attr">\r
16123 <remarks/>\r
16124 </member>\r
16125 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.title">\r
16126 <remarks/>\r
16127 </member>\r
16128 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.firstcontrol">\r
16129 <remarks/>\r
16130 </member>\r
16131 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.defaultcontrol">\r
16132 <remarks/>\r
16133 </member>\r
16134 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.cancelcontrol">\r
16135 <remarks/>\r
16136 </member>\r
16137 <member name="T:NAnt.Contrib.Schemas.Msi.MSIFileOverride">\r
16138 <remarks/>\r
16139 </member>\r
16140 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.file">\r
16141 <remarks/>\r
16142 </member>\r
16143 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.id">\r
16144 <remarks/>\r
16145 </member>\r
16146 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.attr">\r
16147 <remarks/>\r
16148 </member>\r
16149 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.version">\r
16150 <remarks/>\r
16151 </member>\r
16152 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.language">\r
16153 <remarks/>\r
16154 </member>\r
16155 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.checkinterop">\r
16156 <remarks/>\r
16157 </member>\r
16158 <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.installtogac">\r
16159 <remarks/>\r
16160 </member>\r
16161 <member name="T:NAnt.Contrib.Schemas.Msi.MSIKeyFile">\r
16162 <remarks/>\r
16163 </member>\r
16164 <member name="F:NAnt.Contrib.Schemas.Msi.MSIKeyFile.file">\r
16165 <remarks/>\r
16166 </member>\r
16167 <member name="T:NAnt.Contrib.Schemas.Msi.MSIComponent">\r
16168 <remarks/>\r
16169 </member>\r
16170 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.key">\r
16171 <remarks/>\r
16172 </member>\r
16173 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.fileset">\r
16174 <remarks/>\r
16175 </member>\r
16176 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.forceid">\r
16177 <remarks/>\r
16178 </member>\r
16179 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.name">\r
16180 <remarks/>\r
16181 </member>\r
16182 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.id">\r
16183 <remarks/>\r
16184 </member>\r
16185 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.attr">\r
16186 <remarks/>\r
16187 </member>\r
16188 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.directory">\r
16189 <remarks/>\r
16190 </member>\r
16191 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.feature">\r
16192 <remarks/>\r
16193 </member>\r
16194 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.condition">\r
16195 <remarks/>\r
16196 </member>\r
16197 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.fileattr">\r
16198 <remarks/>\r
16199 </member>\r
16200 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.checkinterop">\r
16201 <remarks/>\r
16202 </member>\r
16203 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.installassembliestogac">\r
16204 <remarks/>\r
16205 </member>\r
16206 <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.keepsubdirs">\r
16207 <remarks/>\r
16208 </member>\r
16209 <member name="T:NAnt.Contrib.Schemas.Msi.MSIVariable">\r
16210 <remarks/>\r
16211 </member>\r
16212 <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.name">\r
16213 <remarks/>\r
16214 </member>\r
16215 <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.append">\r
16216 <remarks/>\r
16217 </member>\r
16218 <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.component">\r
16219 <remarks/>\r
16220 </member>\r
16221 <member name="T:NAnt.Contrib.Schemas.Msi.MSIDirectory">\r
16222 <remarks/>\r
16223 </member>\r
16224 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.directory">\r
16225 <remarks/>\r
16226 </member>\r
16227 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.name">\r
16228 <remarks/>\r
16229 </member>\r
16230 <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.foldername">\r
16231 <remarks/>\r
16232 </member>\r
16233 <member name="T:NAnt.Contrib.Schemas.Msi.MSIRootDirectory">\r
16234 <remarks/>\r
16235 </member>\r
16236 <member name="F:NAnt.Contrib.Schemas.Msi.MSIRootDirectory.root">\r
16237 <remarks/>\r
16238 </member>\r
16239 <member name="T:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData">\r
16240 <remarks/>\r
16241 </member>\r
16242 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData.name">\r
16243 <remarks/>\r
16244 </member>\r
16245 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData.value">\r
16246 <remarks/>\r
16247 </member>\r
16248 <member name="T:NAnt.Contrib.Schemas.Msi.MSITableRow">\r
16249 <remarks/>\r
16250 </member>\r
16251 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRow.columns">\r
16252 <remarks/>\r
16253 </member>\r
16254 <member name="T:NAnt.Contrib.Schemas.Msi.MSITableColumn">\r
16255 <remarks/>\r
16256 </member>\r
16257 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.name">\r
16258 <remarks/>\r
16259 </member>\r
16260 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.nullable">\r
16261 <remarks/>\r
16262 </member>\r
16263 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.category">\r
16264 <remarks/>\r
16265 </member>\r
16266 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.categorySpecified">\r
16267 <remarks/>\r
16268 </member>\r
16269 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.type">\r
16270 <remarks/>\r
16271 </member>\r
16272 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.key">\r
16273 <remarks/>\r
16274 </member>\r
16275 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.minvalue">\r
16276 <remarks/>\r
16277 </member>\r
16278 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.minvalueSpecified">\r
16279 <remarks/>\r
16280 </member>\r
16281 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.maxvalue">\r
16282 <remarks/>\r
16283 </member>\r
16284 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.maxvalueSpecified">\r
16285 <remarks/>\r
16286 </member>\r
16287 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keytable">\r
16288 <remarks/>\r
16289 </member>\r
16290 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keycolumn">\r
16291 <remarks/>\r
16292 </member>\r
16293 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keycolumnSpecified">\r
16294 <remarks/>\r
16295 </member>\r
16296 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.set">\r
16297 <remarks/>\r
16298 </member>\r
16299 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.description">\r
16300 <remarks/>\r
16301 </member>\r
16302 <member name="T:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType">\r
16303 <remarks/>\r
16304 </member>\r
16305 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Text">\r
16306 <remarks/>\r
16307 </member>\r
16308 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.UpperCase">\r
16309 <remarks/>\r
16310 </member>\r
16311 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.LowerCase">\r
16312 <remarks/>\r
16313 </member>\r
16314 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Integer">\r
16315 <remarks/>\r
16316 </member>\r
16317 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.DoubleInteger">\r
16318 <remarks/>\r
16319 </member>\r
16320 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.TimeDate">\r
16321 <remarks/>\r
16322 </member>\r
16323 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Identifier">\r
16324 <remarks/>\r
16325 </member>\r
16326 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Property">\r
16327 <remarks/>\r
16328 </member>\r
16329 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Filename">\r
16330 <remarks/>\r
16331 </member>\r
16332 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.WildCardFilename">\r
16333 <remarks/>\r
16334 </member>\r
16335 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Path">\r
16336 <remarks/>\r
16337 </member>\r
16338 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Paths">\r
16339 <remarks/>\r
16340 </member>\r
16341 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.AnyPath">\r
16342 <remarks/>\r
16343 </member>\r
16344 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.DefaultDir">\r
16345 <remarks/>\r
16346 </member>\r
16347 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.RegPath">\r
16348 <remarks/>\r
16349 </member>\r
16350 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Formatted">\r
16351 <remarks/>\r
16352 </member>\r
16353 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Template">\r
16354 <remarks/>\r
16355 </member>\r
16356 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Condition">\r
16357 <remarks/>\r
16358 </member>\r
16359 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.GUID">\r
16360 <remarks/>\r
16361 </member>\r
16362 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Version">\r
16363 <remarks/>\r
16364 </member>\r
16365 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Language">\r
16366 <remarks/>\r
16367 </member>\r
16368 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Binary">\r
16369 <remarks/>\r
16370 </member>\r
16371 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Cabinet">\r
16372 <remarks/>\r
16373 </member>\r
16374 <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Shortcut">\r
16375 <remarks/>\r
16376 </member>\r
16377 <member name="T:NAnt.Contrib.Schemas.Msi.MSITable">\r
16378 <remarks/>\r
16379 </member>\r
16380 <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.columns">\r
16381 <remarks/>\r
16382 </member>\r
16383 <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.rows">\r
16384 <remarks/>\r
16385 </member>\r
16386 <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.name">\r
16387 <remarks/>\r
16388 </member>\r
16389 <member name="T:NAnt.Contrib.Schemas.Msi.searchKeyValue">\r
16390 <remarks/>\r
16391 </member>\r
16392 <member name="F:NAnt.Contrib.Schemas.Msi.searchKeyValue.name">\r
16393 <remarks/>\r
16394 </member>\r
16395 <member name="F:NAnt.Contrib.Schemas.Msi.searchKeyValue.setproperty">\r
16396 <remarks/>\r
16397 </member>\r
16398 <member name="T:NAnt.Contrib.Schemas.Msi.searchKey">\r
16399 <remarks/>\r
16400 </member>\r
16401 <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.value">\r
16402 <remarks/>\r
16403 </member>\r
16404 <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.type">\r
16405 <remarks/>\r
16406 </member>\r
16407 <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.path">\r
16408 <remarks/>\r
16409 </member>\r
16410 <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.root">\r
16411 <remarks/>\r
16412 </member>\r
16413 <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64">\r
16414 <remarks/>\r
16415 </member>\r
16416 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.registry">\r
16417 <remarks/>\r
16418 </member>\r
16419 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.file">\r
16420 <remarks/>\r
16421 </member>\r
16422 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.directory">\r
16423 <remarks/>\r
16424 </member>\r
16425 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.Item64bit">\r
16426 <remarks/>\r
16427 </member>\r
16428 <member name="T:NAnt.Contrib.Schemas.Msi.searchDirfileFile">\r
16429 <remarks/>\r
16430 </member>\r
16431 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.name">\r
16432 <remarks/>\r
16433 </member>\r
16434 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minversion">\r
16435 <remarks/>\r
16436 </member>\r
16437 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxversion">\r
16438 <remarks/>\r
16439 </member>\r
16440 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minsize">\r
16441 <remarks/>\r
16442 </member>\r
16443 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minsizeSpecified">\r
16444 <remarks/>\r
16445 </member>\r
16446 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxsize">\r
16447 <remarks/>\r
16448 </member>\r
16449 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxsizeSpecified">\r
16450 <remarks/>\r
16451 </member>\r
16452 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.mindate">\r
16453 <remarks/>\r
16454 </member>\r
16455 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.mindateSpecified">\r
16456 <remarks/>\r
16457 </member>\r
16458 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxdate">\r
16459 <remarks/>\r
16460 </member>\r
16461 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxdateSpecified">\r
16462 <remarks/>\r
16463 </member>\r
16464 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.languages">\r
16465 <remarks/>\r
16466 </member>\r
16467 <member name="T:NAnt.Contrib.Schemas.Msi.searchDirfile">\r
16468 <remarks/>\r
16469 </member>\r
16470 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.file">\r
16471 <remarks/>\r
16472 </member>\r
16473 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.parent">\r
16474 <remarks/>\r
16475 </member>\r
16476 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.path">\r
16477 <remarks/>\r
16478 </member>\r
16479 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.depth">\r
16480 <remarks/>\r
16481 </member>\r
16482 <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.setproperty">\r
16483 <remarks/>\r
16484 </member>\r
16485 <member name="T:NAnt.Contrib.Schemas.Msi.searchIni">\r
16486 <remarks/>\r
16487 </member>\r
16488 <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.filename">\r
16489 <remarks/>\r
16490 </member>\r
16491 <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.section">\r
16492 <remarks/>\r
16493 </member>\r
16494 <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.key">\r
16495 <remarks/>\r
16496 </member>\r
16497 <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.field">\r
16498 <remarks/>\r
16499 </member>\r
16500 <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.type">\r
16501 <remarks/>\r
16502 </member>\r
16503 <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.setproperty">\r
16504 <remarks/>\r
16505 </member>\r
16506 <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw">\r
16507 <remarks/>\r
16508 </member>\r
16509 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.directory">\r
16510 <remarks/>\r
16511 </member>\r
16512 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.file">\r
16513 <remarks/>\r
16514 </member>\r
16515 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.raw">\r
16516 <remarks/>\r
16517 </member>\r
16518 <member name="T:NAnt.Contrib.Schemas.Msi.searchRegistryValue">\r
16519 <remarks/>\r
16520 </member>\r
16521 <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistryValue.name">\r
16522 <remarks/>\r
16523 </member>\r
16524 <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistryValue.setproperty">\r
16525 <remarks/>\r
16526 </member>\r
16527 <member name="T:NAnt.Contrib.Schemas.Msi.searchRegistry">\r
16528 <remarks/>\r
16529 </member>\r
16530 <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.value">\r
16531 <remarks/>\r
16532 </member>\r
16533 <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.type">\r
16534 <remarks/>\r
16535 </member>\r
16536 <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.path">\r
16537 <remarks/>\r
16538 </member>\r
16539 <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.root">\r
16540 <remarks/>\r
16541 </member>\r
16542 <member name="T:NAnt.Contrib.Schemas.Msi.searchApp">\r
16543 <remarks/>\r
16544 </member>\r
16545 <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.componentid">\r
16546 <remarks/>\r
16547 </member>\r
16548 <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.type">\r
16549 <remarks/>\r
16550 </member>\r
16551 <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.setproperty">\r
16552 <remarks/>\r
16553 </member>\r
16554 <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile">\r
16555 <remarks/>\r
16556 </member>\r
16557 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile.directory">\r
16558 <remarks/>\r
16559 </member>\r
16560 <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile.file">\r
16561 <remarks/>\r
16562 </member>\r
16563 <member name="T:NAnt.Contrib.Schemas.Msi.search">\r
16564 <remarks/>\r
16565 </member>\r
16566 <member name="F:NAnt.Contrib.Schemas.Msi.search.app">\r
16567 <remarks/>\r
16568 </member>\r
16569 <member name="F:NAnt.Contrib.Schemas.Msi.search.registry">\r
16570 <remarks/>\r
16571 </member>\r
16572 <member name="F:NAnt.Contrib.Schemas.Msi.search.ini">\r
16573 <remarks/>\r
16574 </member>\r
16575 <member name="F:NAnt.Contrib.Schemas.Msi.search.dirfile">\r
16576 <remarks/>\r
16577 </member>\r
16578 <member name="F:NAnt.Contrib.Schemas.Msi.search.key">\r
16579 <remarks/>\r
16580 </member>\r
16581 <member name="T:NAnt.Contrib.Schemas.Msi.property">\r
16582 <remarks/>\r
16583 </member>\r
16584 <member name="F:NAnt.Contrib.Schemas.Msi.property.name">\r
16585 <remarks/>\r
16586 </member>\r
16587 <member name="F:NAnt.Contrib.Schemas.Msi.property.value">\r
16588 <remarks/>\r
16589 </member>\r
16590 <member name="T:NAnt.Contrib.Schemas.Msi.summaryinformation">\r
16591 <remarks/>\r
16592 </member>\r
16593 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.title">\r
16594 <remarks/>\r
16595 </member>\r
16596 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.subject">\r
16597 <remarks/>\r
16598 </member>\r
16599 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.author">\r
16600 <remarks/>\r
16601 </member>\r
16602 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.keywords">\r
16603 <remarks/>\r
16604 </member>\r
16605 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.comments">\r
16606 <remarks/>\r
16607 </member>\r
16608 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.template">\r
16609 <remarks/>\r
16610 </member>\r
16611 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.revisionnumber">\r
16612 <remarks/>\r
16613 </member>\r
16614 <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.creatingapplication">\r
16615 <remarks/>\r
16616 </member>\r
16617 <member name="T:NAnt.Contrib.Schemas.Msi.msm">\r
16618 <remarks/>\r
16619 </member>\r
16620 <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduledependencies">\r
16621 <remarks/>\r
16622 </member>\r
16623 <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleexclusions">\r
16624 <remarks/>\r
16625 </member>\r
16626 <member name="F:NAnt.Contrib.Schemas.Msi.msm.modulesequences">\r
16627 <remarks/>\r
16628 </member>\r
16629 <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleignoretables">\r
16630 <remarks/>\r
16631 </member>\r
16632 <member name="F:NAnt.Contrib.Schemas.Msi.msm.modulesubstitutions">\r
16633 <remarks/>\r
16634 </member>\r
16635 <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleconfigurations">\r
16636 <remarks/>\r
16637 </member>\r
16638 <member name="F:NAnt.Contrib.Schemas.Msi.msm.id">\r
16639 <remarks/>\r
16640 </member>\r
16641 <member name="F:NAnt.Contrib.Schemas.Msi.msm.language">\r
16642 <remarks/>\r
16643 </member>\r
16644 <member name="F:NAnt.Contrib.Schemas.Msi.msm.version">\r
16645 <remarks/>\r
16646 </member>\r
16647 <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleDependency">\r
16648 <remarks/>\r
16649 </member>\r
16650 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.id">\r
16651 <remarks/>\r
16652 </member>\r
16653 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.language">\r
16654 <remarks/>\r
16655 </member>\r
16656 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.version">\r
16657 <remarks/>\r
16658 </member>\r
16659 <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion">\r
16660 <remarks/>\r
16661 </member>\r
16662 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.id">\r
16663 <remarks/>\r
16664 </member>\r
16665 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.language">\r
16666 <remarks/>\r
16667 </member>\r
16668 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.minversion">\r
16669 <remarks/>\r
16670 </member>\r
16671 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.maxversion">\r
16672 <remarks/>\r
16673 </member>\r
16674 <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleSequence">\r
16675 <remarks/>\r
16676 </member>\r
16677 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.type">\r
16678 <remarks/>\r
16679 </member>\r
16680 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.action">\r
16681 <remarks/>\r
16682 </member>\r
16683 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.sequence">\r
16684 <remarks/>\r
16685 </member>\r
16686 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.sequenceSpecified">\r
16687 <remarks/>\r
16688 </member>\r
16689 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.baseaction">\r
16690 <remarks/>\r
16691 </member>\r
16692 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.after">\r
16693 <remarks/>\r
16694 </member>\r
16695 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.condition">\r
16696 <remarks/>\r
16697 </member>\r
16698 <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleIgnoreTable">\r
16699 <remarks/>\r
16700 </member>\r
16701 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleIgnoreTable.name">\r
16702 <remarks/>\r
16703 </member>\r
16704 <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution">\r
16705 <remarks/>\r
16706 </member>\r
16707 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.table">\r
16708 <remarks/>\r
16709 </member>\r
16710 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.row">\r
16711 <remarks/>\r
16712 </member>\r
16713 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.column">\r
16714 <remarks/>\r
16715 </member>\r
16716 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.value">\r
16717 <remarks/>\r
16718 </member>\r
16719 <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration">\r
16720 <remarks/>\r
16721 </member>\r
16722 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.name">\r
16723 <remarks/>\r
16724 </member>\r
16725 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.format">\r
16726 <remarks/>\r
16727 </member>\r
16728 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.type">\r
16729 <remarks/>\r
16730 </member>\r
16731 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.contextdata">\r
16732 <remarks/>\r
16733 </member>\r
16734 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.defaultvalue">\r
16735 <remarks/>\r
16736 </member>\r
16737 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.attr">\r
16738 <remarks/>\r
16739 </member>\r
16740 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.displayname">\r
16741 <remarks/>\r
16742 </member>\r
16743 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.description">\r
16744 <remarks/>\r
16745 </member>\r
16746 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.helplocation">\r
16747 <remarks/>\r
16748 </member>\r
16749 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.helpkeyword">\r
16750 <remarks/>\r
16751 </member>\r
16752 <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat">\r
16753 <remarks/>\r
16754 </member>\r
16755 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.text">\r
16756 <remarks/>\r
16757 </member>\r
16758 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.key">\r
16759 <remarks/>\r
16760 </member>\r
16761 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.integer">\r
16762 <remarks/>\r
16763 </member>\r
16764 <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.bitfield">\r
16765 <remarks/>\r
16766 </member>\r
16767 </members>\r
16768 </doc>\r