~halega/+junk/sharpdevelop

The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.

1433

</returns>

1434

</member>

1435

1436

1437

Gets or sets a value indicating whether the output is verbose.

1438

</summary>

1439

<value><c>true</c> if verbose; otherwise, <c>false</c>.</value>

1440

</member>

1441

1442

1443

Gets or sets a value indicating whether the build should

1444

fail if static code analysis reports errors. Defaults to

1445

<c>true</c>.

1446

</summary>

1447

<value><c>true</c> if verbose; otherwise, <c>false</c>.</value>

1448

</member>

1449

1450

1451

Gets the name of the executable file to run.

1452

</summary>

1453

1454

<returns>The name of the executable file to run.</returns>

1455

</member>

1456

1457

1458

Base task for any IIS-related task.

1459

</summary>

1460

<remarks>Stores the base logic for gathering the IIS version and server and port checking. This

1461

base task also stores common properties for other related tasks.</remarks>

1462

</member>

1463

1464

1465

IIS version.

1466

</summary>

1467

</member>

1468

1469

1470

Gets the IIS version.

1471

</summary>

1472

1473

1474

</member>

1475

1476

1477

Gets the remote machine OS version.

1478

</summary>

1479

<returns>Returns a <see cref="T:System.Version"/> of the operating system.</returns>

1480

1481

</member>

1482

1483

1484

Verifies that the IIS root exists based on the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerName"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerPort"/>.

1485

</summary>

1486

1487

</member>

1488

1489

1490

Helper method for <see cref="M:MSBuild.Community.Tasks.IIS.WebBase.VerifyIISRoot"/> that verifies the server port exists.

1491

</summary>

1492

<param name="site">The site to verify the port.</param>

1493

<returns>Boolean value indicating the status of the port check.</returns>

1494

1495

</member>

1496

1497

1498

Gets or sets the name of the server. The default value is 'localhost'.

1499

</summary>

1500

<value>The name of the server.</value>

1501

</member>

1502

1503

1504

Gets or sets the server port.

1505

</summary>

1506

<value>The server port.</value>

1507

</member>

1508

1509

1510

Gets or sets the IIS server path.

1511

</summary>

1512

<remarks>Is in the form 'IIS://localhost/W3SVC/1/Root'.</remarks>

1513

<value>The IIS server path.</value>

1514

</member>

1515

1516

1517

Gets or sets the application path.

1518

</summary>

1519

1520

<value>The application path.</value>

1521

</member>

1522

1523

1524

Gets or sets the IIS application pool path.

1525

</summary>

1526

<remarks>Is in the form 'IIS://localhost/W3SVC/AppPools'.</remarks>

1527

<value>The IIS application pool path.</value>

1528

</member>

1529

1530

1531

Gets or sets the username for the account the task will run under. This property

1532

is needed if you specified a <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerName"/> for a remote machine.

1533

</summary>

1534

<value>The username of the account.</value>

1535

</member>

1536

1537

1538

Gets or sets the password for the account the task will run under. This property

1539

is needed if you specified a <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerName"/> for a remote machine.

1540

</summary>

1541

<value>The password of the account.</value>

1542

</member>

1543

1544

1545

Defines the possible IIS versions supported by the task.

1546

</summary>

1547

</member>

1548

1549

1550

IIS version 4.x

1551

</summary>

1552

</member>

1553

1554

1555

IIS version 5.x

1556

</summary>

1557

</member>

1558

1559

1560

IIS version 6.x

1561

</summary>

1562

</member>

1563

1564

1565

Defines the possible application pool actions to be performed.

1566

</summary>

1567

</member>

1568

1569

1570

Recycles an application pool.

1571

</summary>

1572

</member>

1573

1574

1575

Stops and restarts the application pool.

1576

</summary>

1577

</member>

1578

1579

1580

Starts the application pool.

1581

</summary>

1582

</member>

1583

1584

1585

Stops the application pool.

1586

</summary>

1587

</member>

1588

1589

1590

Defines the current application pool state.

1591

</summary>

1592

</member>

1593

1594

1595

The application pool is starting.

1596

</summary>

1597

</member>

1598

1599

1600

The application pool has started.

1601

</summary>

1602

</member>

1603

1604

1605

The application pool is stopping.

1606

</summary>

1607

</member>

1608

1609

1610

The application pool has stopped.

1611

</summary>

1612

</member>

1613

1614

1615

Defines the actions that can be performed on a service.

1616

</summary>

1617

</member>

1618

1619

1620

Starts a service.

1621

</summary>

1622

</member>

1623

1624

1625

Stops a service.

1626

</summary>

1627

</member>

1628

1629

1630

Restarts a service.

1631

</summary>

1632

</member>

1633

1634

1635

Pauses a running service.

1636

</summary>

1637

</member>

1638

1639

1640

Continues a paused service.

1641

</summary>

1642

</member>

1643

1644

1645

Task that can control a Windows service.

1646

</summary>

1647

1648

<para>Restart Web Server</para>

1649

<code><![CDATA[

1650

1651

]]></code>

1652

</example>

1653

</member>

1654

1655

1656

Task that can determine the status of a specified service

1657

on a target server.

1658

</summary>

1659

1660

<para>Check status of SQL Server</para>

1661

<code><![CDATA[

1662

1663

1664

</ServiceQuery>

1665

1666

]]></code>

1667

</example>

1668

</member>

1669

1670

1671

The unknown <see cref="P:MSBuild.Community.Tasks.ServiceQuery.Status"/>

1672

returned when the service does not exist.

1673

The value is "Unknown".

1674

</summary>

1675

</member>

1676

1677

1678

Initializes a new instance of the <see cref="T:ServiceQuery"/> class.

1679

</summary>

1680

</member>

1681

1682

1683

Executes the task.

1684

</summary>

1685

<returns><see langword="true"/> if the task ran successfully;

1686

otherwise <see langword="false"/>.</returns>

1687

</member>

1688

1689

1690

Gets the service controller.

1691

</summary>

1692

1693

</member>

1694

1695

1696

Gets or sets the name of the service.

1697

</summary>

1698

<value>The name of the service.</value>

1699

</member>

1700

1701

1702

Gets or sets the name of the machine.

1703

</summary>

1704

<value>The name of the machine.</value>

1705

</member>

1706

1707

1708

Gets or sets the status.

1709

</summary>

1710

<value>The status of the service.</value>

1711

</member>

1712

1713

1714

Gets a value indicating whether the service can be paused and resumed.

1715

</summary>

1716

<value>

1717

<c>true</c> if this instance can pause and continue; otherwise, <c>false</c>.

1718

</value>

1719

</member>

1720

1721

1722

Gets a value indicating whether the service should be notified when the system is shutting down.

1723

</summary>

1724

<value>

1725

<c>true</c> if this instance can shutdown; otherwise, <c>false</c>.

1726

</value>

1727

</member>

1728

1729

1730

Gets a value indicating whether the service can be stopped after it has started.

1731

</summary>

1732

<value><c>true</c> if this instance can stop; otherwise, <c>false</c>.</value>

1733

</member>

1734

1735

1736

Gets a friendly name for the service.

1737

</summary>

1738

<value>The name of the display.</value>

1739

</member>

1740

1741

1742

Gets a value indicating whether the service exists.

1743

</summary>

1744

<value><c>true</c> if the service exists; otherwise, <c>false</c>.</value>

1745

</member>

1746

1747

1748

Initializes a new instance of the <see cref="T:ServiceController"/> class.

1749

</summary>

1750

</member>

1751

1752

1753

Executes the task.

1754

</summary>

1755

<returns><see langword="true"/> if the task ran successfully;

1756

otherwise <see langword="false"/>.</returns>

1757

</member>

1758

1759

1760

Gets or sets the <see cref="T:ServiceActions"/> to perform on the service.

1761

</summary>

1762

<value>The action to perform on the service.</value>

1763

1764

</member>

1765

1766

1767

Gets or sets the timeout for the command. The default is

1768

one minute.

1769

</summary>

1770

<value>The timeout for the command.</value>

1771

</member>

1772

1773

1774

Task that can strip the source control information from a

1775

Visual Studio Solution and subprojects.

1776

</summary>

1777

<remarks>This task is useful if you keep an archive of the

1778

source tree at each build milestone, because it's irritating to have

1779

to remove source control binding manually once you've copied a

1780

version of the code from your archive.</remarks>

1781

</member>

1782

1783

1784

Executes the task.

1785

</summary>

1786

<returns><see langword="true"/> if the task ran successfully;

1787

otherwise <see langword="false"/>.</returns>

1788

</member>

1789

1790

1791

Uploads a file using File Transfer Protocol (FTP).

1792

</summary>

1793

<example>Upload a file.

1794

<code><![CDATA[

1795

<FtpUpload

1796

LocalFile="MSBuild.Community.Tasks.zip"

1797

RemoteUri="ftp://localhost/MSBuild.Community.Tasks.zip" />

1798

]]></code>

1799

</example>

1800

</member>

1801

1802

1803

Initializes a new instance of the <see cref="T:FtpUpload"/> class.

1804

</summary>

1805

</member>

1806

1807

1808

When overridden in a derived class, executes the task.

1809

</summary>

1810

1811

true if the task successfully executed; otherwise, false.

1812

</returns>

1813

</member>

1814

1815

1816

Gets or sets the local file to upload.

1817

</summary>

1818

<value>The local file.</value>

1819

</member>

1820

1821

1822

Gets or sets the remote URI to upload.

1823

</summary>

1824

<value>The remote URI.</value>

1825

</member>

1826

1827

1828

Gets or sets the username.

1829

</summary>

1830

<value>The username.</value>

1831

</member>

1832

1833

1834

Gets or sets the password.

1835

</summary>

1836

<value>The password.</value>

1837

</member>

1838

1839

1840

Gets or sets the behavior of a client application's data transfer process.

1841

</summary>

1842

<value><c>true</c> if [use passive]; otherwise, <c>false</c>.</value>

1843

</member>

1844

1845

1846

Creates a new application pool on a local or remote machine with IIS installed. The default is

1847

to create the new application pool on the local machine. If connecting to a remote machine, you can

1848

specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task

1849

to run under.

1850

</summary>

1851

<example>Create a new application pool on the local machine.

1852

<code><![CDATA[

1853

1854

]]></code>

1855

</example>

1856

</member>

1857

1858

1859

When overridden in a derived class, executes the task.

1860

</summary>

1861

1862

True if the task successfully executed; otherwise, false.

1863

</returns>

1864

</member>

1865

1866

1867

Gets or sets the name of the application pool.

1868

</summary>

1869

<value>The name of the application pool.</value>

1870

</member>

1871

1872

1873

The AppPoolAutoStart property indicates to the World Wide Web Publishing Service (WWW service)

1874

to automatically start an application pool when the application pool is created or when IIS

1875

is started, if the value of this property is set to true.

1876

</summary>

1877

<value>Value indicating if AppPoolAutoStart is enabled or disabled.</value>

1878

</member>

1879

1880

1881

The AppPoolIdentityType property allows application pools to run as a specific user account:

1882

1883

0 - The application pool runs as NT AUTHORITY\SYSTEM.

1884

1 - The application pool runs as NT AUTHORITY\LOCAL SERVICE.

1885

2 - The application pool runs as NT AUTHORITY\NETWORK SERVICE.

1886

3 - The application pool runs as a specific user account, defined by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserName"/> property.

1887

</summary>

1888

<value>Value indicating the application pool identity type.</value>

1889

</member>

1890

1891

1892

The AppPoolQueueLength property indicates to the Universal Listener how many requests

1893

to queue up for an application pool before rejecting future requests. When the limit

1894

for this property is exceeded, IIS rejects the additional requests with a 503 error.

1895

</summary>

1896

<value>Value indicating the application pool queue length.</value>

1897

</member>

1898

1899

1900

The AutoShutdownAppPoolExe property specifies an executable to run when the World Wide Web

1901

Publishing Service (WWW service) shuts down an application pool for rapid fail protection. You

1902

can use the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.AutoShutdownAppPoolParams"/> property to send parameters to the executable.

1903

</summary>

1904

<value>Value indicating the application pool auto shutdown executable.</value>

1905

</member>

1906

1907

1908

The AutoShutdownAppPoolParams property specifies any command-line parameters for the executable that

1909

is specified in the AutoShutdownAppPoolExe property. You can use these two properties in the following

1910

way to send e-mail, for example, when the World Wide Web Publishing Service (WWW service) shuts down

1911

an application pool for rapid fail protection:

1912

1913

AutoShutdownAppPoolExe = "C:\LogAndSendMail.bat"

1914

AutoShutdownAppPoolParams = "-AppPoolName %1%"

1915

1916

where %1% represents the application pool name.

1917

</summary>

1918

<value>Value indicating the parameters for the application pool auto shutdown executable.</value>

1919

</member>

1920

1921

1922

The CPUAction property configures the action(s) that IIS takes when Microsoft Windows NT ® job objects

1923

run. Only one Windows NT job object exists per application pool, therefore the CPUAction property

1924

is configured on a per application pool basis.

1925

1926

Possible values:

1927

0 - No action is taken except that a warning is written to the event log when the CPU limit is exceeded.

1928

1 - Application pool worker processes that exceed their CPU limit will be forced to shut down.

1929

</summary>

1930

<value>Value indicating the CPU action.</value>

1931

</member>

1932

1933

1934

The CPULimit property configures the maximum percentage of CPU resources that worker processes

1935

in an application pool are allowed to consume over a period of time, as indicated by the

1936

<see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.CPUResetInterval"/> property. Set this property by specifying a percentage of CPU

1937

usage, multiplied by 1000. For example, if you want the CPU usage limit to be 50%, set CPULimit to 50,000.

1938

</summary>

1939

<value>Value indicating the CPU limit.</value>

1940

</member>

1941

1942

1943

The CPUResetInterval property specifies the reset period (in minutes) for CPU monitoring and

1944

throttling limits on the application pool. When the number of minutes elapsed since the last

1945

process accounting reset equals the number specified by this property, IIS will reset the CPU

1946

timers for both the logging and limit intervals. Setting the value of this property to 0

1947

disables CPU monitoring.

1948

</summary>

1949

<value>Value indicating the CPU reset interval.</value>

1950

</member>

1951

1952

1953

The DisallowOverlappingRotation property specifies whether or not the World Wide Web Publishing

1954

Service (WWW Service) should start up another worker process to replace the existing worker

1955

process while it is shutting down.

1956

</summary>

1957

<value>Value indicating the DisallowOverlappingRotation.</value>

1958

</member>

1959

1960

1961

The DisallowRotationOnConfigChange property specifies whether or not the World Wide Web Publishing

1962

Service (WWW Service) should rotate worker processes in an application pool when the configuration

1963

has changed. This means that the worker processes will not pick up application pool changes to

1964

values passed to the worker process, such as <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.IdleTimeout"/> and <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PeriodicRestartRequests"/>.

1965

</summary>

1966

<value>Value indicating the DisallowRotationOnConfigChange.</value>

1967

</member>

1968

1969

1970

The IdleTimeout property specifies how long (in minutes) a worker process should run idle if no new

1971

requests are received and the worker process is not processing requests. After the allotted time

1972

passes, the worker process should request to be shut down by the World Wide Web Publishing Service (WWW Service).

1973

</summary>

1974

<value>Value indicating the idle timeout.</value>

1975

</member>

1976

1977

1978

The LoadBalancerCapabilities property specifies behavior when a service is unavailable. A setting of 1

1979

terminates the connection. A setting of 2 sends error code 503.

1980

</summary>

1981

<value>Value indicating the load balancer capabilities.</value>

1982

</member>

1983

1984

1985

The LogEventOnRecycle property specifies that IIS should log an event when an application pool is

1986

recycled. Application pools recycle for a variety of reasons. In order for IIS to log the event, the

1987

LogEventOnRecycle property must have a bit set corresponding to the reason for the recycle.

1988

</summary>

1989

<value>Value indicating which recycle events to log.</value>

1990

</member>

1991

1992

1993

The LogonMethod property contains an integer that specifies the logon method for cleartext

1994

logons. Valid settings are:

1995

1996

0 for interactive logon.

1997

1 for batch logon.

1998

2 for network logon.

1999

3 for cleartext logon.

2000

</summary>

2001

<value>Value indicating the logon method.</value>

2002

</member>

2003

2004

2005

The MaxProcesses property determines the maximum number of worker processes an application pool

2006

allows to service requests for an application pool. This property cannot be set to 0 because there

2007

are no unmanaged pools.

2008

</summary>

2009

<value>Value indicating the maximum number of worker processes allowed by the application pool.</value>

2010

</member>

2011

2012

2013

The OrphanActionExe property specifies an executable to run when the World Wide Web Publishing

2014

Service (WWW service) orphans a worker process. You can use the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.OrphanActionParams"/> property

2015

to send parameters to the executable.

2016

</summary>

2017

<value>The value for the orphan action executable.</value>

2018

</member>

2019

2020

2021

The OrphanActionParams property specifies command-line parameters for the executable

2022

specified by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.OrphanActionExe"/> property.

2023

</summary>

2024

<value>Value indicating the orphan action parameters.</value>

2025

</member>

2026

2027

2028

The OrphanWorkerProcess property, when set to true, notifies the World Wide Web Publishing

2029

Service (WWW Service) not to terminate a worker process that fails to respond to pings, but

2030

to instead orphan the worker process in the application pool if the worker process suffers

2031

fatal errors.

2032

</summary>

2033

<value>Value indicating the orphan worker process.</value>

2034

</member>

2035

2036

2037

The PeriodicRestartMemory property specifies the amount of virtual memory (in KB) that a

2038

worker process can use before the worker process recycles. The maximum value supported

2039

for this property is 4,294,967 KB.

2040

</summary>

2041

<value>Value indicating the amount of memory.</value>

2042

</member>

2043

2044

2045

The PeriodicRestartPrivateMemory property specifies the amount of private memory (in KB) that a

2046

worker process can use before the worker process recycles. The maximum value supported

2047

for this property is 4,294,967 KB.

2048

</summary>

2049

<value>Value indicating the amount of memory.</value>

2050

</member>

2051

2052

2053

The PeriodicRestartRequests property indicates the number of requests the OOP application

2054

should process, after which it is recycled.

2055

</summary>

2056

<value>Value indicating the number of requests.</value>

2057

</member>

2058

2059

2060

The PeriodicRestartSchedule property specifies the time (in 24 hour format) that the application

2061

will be rotated. Each time is in local time and is specified in the following format:

2062

2063

PeriodicRestartSchedule="hh:mm,hh:mm,hh:mm"

2064

</summary>

2065

<value>Value indicating the restart schedule.</value>

2066

</member>

2067

2068

2069

The PeriodicRestartTime property specifies the period of time, in minutes, after which IIS

2070

rotates an isolated OOP application. Setting the value of this property to 0 disables the

2071

property. The maximum supported value for this property is 71,582.

2072

</summary>

2073

<value>Value indicating the restart time period.</value>

2074

</member>

2075

2076

2077

The PingingEnabled property specifies whether the World Wide Web Publishing Service

2078

(WWW Service) should periodically monitor the health of a worker process. Setting the

2079

value of this property to true indicates to the WWW service to monitor the worker

2080

processes to ensure that the they are running and healthy.

2081

</summary>

2082

<value>Value indicating if pinging is enabled or disabled.</value>

2083

</member>

2084

2085

2086

The PingInterval property specifies the period of time (in seconds) between health-monitoring

2087

pings that the World Wide Web Publishing Service (WWW Service) sends to a worker process.

2088

</summary>

2089

<value>Value indicating the ping interval.</value>

2090

</member>

2091

2092

2093

The PingResponseTime property specifies the amount of time (in seconds) that a worker process

2094

is given to respond to a health monitoring ping. After the time limit is exceeded, the World

2095

Wide Web Publishing Service (WWW Service) terminates the worker process.

2096

</summary>

2097

<value>Value indicating the ping response time.</value>

2098

</member>

2099

2100

2101

Setting the RapidFailProtection property to true instructs the World Wide Web Publishing

2102

Service (WWW service) to put all applications in an application pool out of service if the

2103

number of worker process crashes has reached the maximum specified by the

2104

<see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionMaxCrashes"/> property, within the number of minutes specified

2105

by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionInterval"/> property.

2106

</summary>

2107

<value>Value indicating if rapid fail protection is enabled or disabled.</value>

2108

</member>

2109

2110

2111

The RapidFailProtectionInterval property specifies the number of minutes before the failure

2112

count for a process is reset. See <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtection"/>.

2113

</summary>

2114

<value>Value indicating the rapid fail protection interval.</value>

2115

</member>

2116

2117

2118

The RapidFailProtectionMaxCrashes property specifies the maximum number of failures

2119

allowed within the number of minutes specified by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionInterval"/>

2120

property. See <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtection"/>.

2121

</summary>

2122

<value>Value indicating the maximum number of crashes.</value>

2123

</member>

2124

2125

2126

The ShutdownTimeLimit property specifies the amount of time (in seconds) after a recycle

2127

threshold has been reached that IIS waits for all old requests to finish running in a worker

2128

process before terminating the worker process.

2129

</summary>

2130

<value>Value indicating the shutdown time limit.</value>

2131

</member>

2132

2133

2134

Setting the SMPAffinitized property to true indicates that a particular worker process

2135

assigned to an application pool should be assigned to a given CPU. This property is used

2136

in conjunction with the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.SMPProcessorAffinityMask"/> property to configure a

2137

particular processor a worker process will be assigned to.

2138

</summary>

2139

<value>Value indicating if SMPAffinitized is enabled or disabled.</value>

2140

</member>

2141

2142

2143

The SMPProcessorAffinityMask property configures the hexadecimal processor mask. The hexadecimal

2144

processor mask indicates to which CPU the worker processes in an application pool should be

2145

bound. Before this property takes affect, the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.SMPAffinitized"/> property must be set

2146

to true for the application pool. These properties cannot be set through IIS Manager.

2147

2148

Do not set this property to zero. Doing so causes no SMP affinity to be configured, creating an

2149

error condition. The default DWORD value is 4294967295 (or -1), which is represented in hexadecimal

2150

as 0xFFFFFFFF. A value of 0xFFFFFFFF in SMPProcessorAffinityMask indicates that all processors are enabled.

2151

</summary>

2152

<value>Value indicating the SMP processor affinity bit mask.</value>

2153

</member>

2154

2155

2156

The value of the StartupTimeLimit property specifies the amount of time (in seconds) that the World Wide

2157

Web Publishing Service (WWW Service) should wait for a worker process to finish starting up and

2158

reporting to the WWW Service.

2159

</summary>

2160

<value>Value indicating the startup time limit.</value>

2161

</member>

2162

2163

2164

The WAMUserName property specifies the account user name that IIS uses by default as the COM+

2165

application identity for newly created IIS out-of-process applications. The values of this

2166

property and its companion property, <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserPass"/>, are set when IIS is installed, and

2167

match the user name and password values in the Microsoft Windows user account, which is established

2168

at the same time. Changing the value of this property is not recommended. If you do, change

2169

it to a valid Windows user account, and change WAMUserPass to the corresponding password

2170

for the new account.

2171

2172

Important:

2173

Changes to WAMUserName and WAMUserPass may disrupt the operation of existing IIS out-of-process

2174

applications. You can synchronize application identities using Component Services to edit the

2175

user name and password values, found on the Identity tab of the property sheet for each package.

2176

2177

In-process applications are not affected by these property values.

2178

</summary>

2179

<value>Value indicating the username.</value>

2180

</member>

2181

2182

2183

The WAMUserPass property specifies the password for the account that IIS uses by default as the COM+

2184

application identity for newly created IIS out-of-process applications. The values of this property

2185

and its companion property, <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserName"/>, are set when IIS is installed, and match the

2186

password and user name values in the Microsoft Windows user account (IWAM_ MachineName, where MachineName

2187

is the name of the machine on which IIS is installed) established at the same time.

2188

2189

Important:

2190

Changing the value of this property is not recommended. If you do, you must change the Windows account

2191

password to the identical value. You must also synchronize existing IIS out-of-process application

2192

identities, using Component Services to edit the user name and password values, which are found on the

2193

Identity tab of the property sheet for each package.

2194

2195

In-process applications are not affected by these property values.

2196

</summary>

2197

<value>Value indicating the password.</value>

2198

</member>

2199

2200

2201

Creates a new web directory on a local or remote machine with IIS installed. The default is

2202

to create the new web directory on the local machine. The physical path is required to already exist

2203

on the target machine. If connecting to a remote machine, you can specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/>

2204

and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task to run under.

2205

</summary>

2206

<example>Create a new web directory on the local machine.

2207

<code><![CDATA[

2208

<WebDirectoryCreate VirtualDirectoryName="MyVirDir"

2209

VirtualDirectoryPhysicalPath="C:\Inetpub\MyWebDir" />

2210

]]></code>

2211

</example>

2212

</member>

2213

2214

2215

When overridden in a derived class, executes the task.

2216

</summary>

2217

2218

True if the task successfully executed; otherwise, false.

2219

</returns>

2220

</member>

2221

2222

2223

Gets or sets the name of the virtual directory.

2224

</summary>

2225

<value>The name of the virtual directory.</value>

2226

</member>

2227

2228

2229

Gets or sets the virtual directory physical path. The physical directory must

2230

exist before this task executes.

2231

</summary>

2232

<value>The virtual directory physical path.</value>

2233

</member>

2234

2235

2236

Gets or sets a value that indicates if the file

2237

or the contents of the folder may be executed, regardless of file type.

2238

</summary>

2239

<value>A value indicating if AccessExecute is enabled or disabled.</value>

2240

</member>

2241

2242

2243

A value of true indicates that remote requests to execute applications

2244

are denied; only requests from the same computer as the IIS server succeed

2245

if the AccessExecute property is set to true. You cannot set

2246

AccessNoRemoteExecute to false to enable remote requests, and set

2247

<see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessExecute"/> to false to disable local requests.

2248

</summary>

2249

<value>Value indicating if AccessNoRemoteExecute is enabled or disabled.</value>

2250

</member>

2251

2252

2253

A value of true indicates that remote requests to view files are denied; only

2254

requests from the same computer as the IIS server succeed if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessRead"/>

2255

property is set to true. You cannot set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessNoRemoteRead"/> to false to enable

2256

remote requests, and set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessRead"/> to false to disable local requests.

2257

</summary>

2258

<value>Value indicating if AccessNoRemoteRead is enabled or disabled.</value>

2259

</member>

2260

2261

2262

A value of true indicates that remote requests to view dynamic content are denied; only

2263

requests from the same computer as the IIS server succeed if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessScript"/> property

2264

is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests,

2265

and set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessScript"/> to false to disable local requests.

2266

</summary>

2267

<value>Value indicating if AccessNoRemoteScript is enabled or disabled.</value>

2268

</member>

2269

2270

2271

A value of true indicates that remote requests to create or change files are denied; only

2272

requests from the same computer as the IIS server succeed if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessWrite"/> property

2273

is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests,

2274

and set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessWrite"/> to false to disable local requests.

2275

</summary>

2276

<value>Value indicating if AccessNoRemoteWrite is enabled or disabled.</value>

2277

</member>

2278

2279

2280

A value of true indicates that the file or the contents of the folder may be read

2281

through Microsoft Internet Explorer.

2282

</summary>

2283

<value>Value indicating if AccessRead is enabled or disabled.</value>

2284

</member>

2285

2286

2287

A value of true indicates that users are allowed to access source code if either

2288

Read or Write permissions are set. Source code includes scripts in Microsoft ® Active

2289

Server Pages (ASP) applications.

2290

</summary>

2291

<value>Value indicating if AccessSource is enabled or disabled.</value>

2292

</member>

2293

2294

2295

A value of true indicates that the file or the contents of the folder may be executed

2296

if they are script files or static content. A value of false only allows static files,

2297

such as HTML files, to be served.

2298

</summary>

2299

<value>Value indicating if AccessScript is enabled or disabled.</value>

2300

</member>

2301

2302

2303

A value of true indicates that file access requires SSL file permission processing, with

2304

or without a client certificate.

2305

</summary>

2306

<value>Value indicating if AccessSsl is enabled or disabled.</value>

2307

</member>

2308

2309

2310

A value of true indicates that file access requires SSL file permission processing

2311

with a minimum key size of 128 bits, with or without a client certificate.

2312

</summary>

2313

<value>Value indicating if AccessSsl128 is enabled or disabled.</value>

2314

</member>

2315

2316

2317

A value of true indicates that SSL file permission processing maps a client certificate

2318

to a Microsoft Windows ® operating system user-account. The <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslNegotiateCert"/> property

2319

must also be set to true for the mapping to occur.

2320

</summary>

2321

<value>Value indicating if AccessSslMapCert is enabled or disabled.</value>

2322

</member>

2323

2324

2325

A value of true indicates that SSL file access processing requests a certificate from

2326

the client. A value of false indicates that access continues if the client does not have

2327

a certificate. Some versions of Internet Explorer will close the connection if the server

2328

requests a certificate and a certificate is not available (even if <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslRequireCert"/>

2329

is also set to true).

2330

</summary>

2331

<value>Value indicating if AccessSslNegotiateCert is enabled or disabled.</value>

2332

</member>

2333

2334

2335

A value of true indicates that SSL file access processing requests a certificate from the

2336

client. If the client provides no certificate, the connection is closed. <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslNegotiateCert"/>

2337

must also be set to true when using AccessSSLRequireCert.

2338

</summary>

2339

<value>Value indicating if AccessSslRequireCert is enabled or disabled.</value>

2340

</member>

2341

2342

2343

A value of true indicates that users are allowed to upload files and their associated

2344

properties to the enabled directory on your server or to change content in a Write-enabled

2345

file. Write can be implemented only with a browser that supports the PUT feature of

2346

the HTTP 1.1 protocol standard.

2347

</summary>

2348

<value>Value indicating if AccessWrite is enabled or disabled.</value>

2349

</member>

2350

2351

2352

The AnonymousPasswordSync property indicates whether IIS should handle the user password

2353

for anonymous users attempting to access resources.

2354

</summary>

2355

<value>Value indicating if AnonymousPasswordSync is enabled or disabled.</value>

2356

</member>

2357

2358

2359

The AppAllowClientDebug property specifies whether ASP client-side debugging

2360

is enabled. This property is independent of <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AppAllowDebugging"/>, which

2361

applies to server-side debugging.

2362

</summary>

2363

<value>Value indicating if AppAllowClientDebug is enabled or disabled.</value>

2364

</member>

2365

2366

2367

The AppAllowDebugging property specifies whether ASP debugging is enabled on

2368

the server. This property is independent of the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AppAllowClientDebug"/> property,

2369

which applies to client-side debugging.

2370

</summary>

2371

<value>Value indicating if AppAllowDebugging is enabled or disabled.</value>

2372

</member>

2373

2374

2375

The AspAllowSessionState property enables session state persistence for the ASP application.

2376

</summary>

2377

<value>Value indicating if the AspAllowSessionState is enabled or disabled.</value>

2378

</member>

2379

2380

2381

The AspBufferingOn property specifies whether output from an ASP application will be buffered.

2382

</summary>

2383

<value>Value indicating if the AspBufferingOn is enabled or disabled.</value>

2384

</member>

2385

2386

2387

The AspEnableApplicationRestart determines whether an ASP application can be

2388

automatically restarted. When changes are made to Global.asa or metabase properties

2389

that affect an application, the application will not restart unless the

2390

AspEnableApplicationRestart property is set to true.

2391

</summary>

2392

<value>Value indicating if AspEnableApplicationRestart is enabled or disabled.</value>

2393

</member>

2394

2395

2396

The AspEnableAspHtmlFallback property controls the behavior of ASP when a

2397

new request is to be rejected due to a full request queue.

2398

</summary>

2399

<value>Value indicating if AspEnableAspHtmlFallback is enabled or disabled.</value>

2400

</member>

2401

2402

2403

The AspEnableChunkedEncoding property specifies whether HTTP 1.1 chunked

2404

transfer encoding is enabled for the World Wide Web Publishing Service (WWW service).

2405

</summary>

2406

<value>Value indicating if AspEnableChunkedEncoding is enabled or disabled.</value>

2407

</member>

2408

2409

2410

The AspErrorsToNTLog property specifies which ASP errors are written to the

2411

Windows event log. ASP errors are written to the client browser and to the IIS

2412

log files by default.

2413

</summary>

2414

<value>Value indicating if AspErrorsToNTLog is enabled or disabled.</value>

2415

</member>

2416

2417

2418

The AspEnableParentPaths property specifies whether an ASP page allows paths

2419

relative to the current directory (using the ..\ notation) or above the current directory.

2420

</summary>

2421

<value>Value indicating if AspEnableParentPaths is enabled or disabled.</value>

2422

</member>

2423

2424

2425

The AspEnableTypelibCache property specifies whether type libraries are cached

2426

on the server. The World Wide Web Publishing Service (WWW service) setting for

2427

this property is applicable to all in-process and pooled out-of-process application

2428

nodes, at all levels. Metabase settings at the Web server level or lower are ignored

2429

for in-process and pooled out-of-process applications. However, settings at the Web

2430

server level or lower are used if that node is an isolated out-of-process application.

2431

</summary>

2432

<value>Value indicating if AspEnableTypelibCache is enabled or disabled.</value>

2433

</member>

2434

2435

2436

The AspExceptionCatchEnable property specifies whether ASP pages trap exceptions

2437

thrown by components.

2438

</summary>

2439

<value>Value indicating if AspExceptionCatchEnable is enabled or disabled.</value>

2440

</member>

2441

2442

2443

The AspLogErrorRequests property controls whether the Web server writes ASP errors

2444

to the application section of the Windows event log. ASP errors are written to the

2445

client browser and to the IIS log files by default.

2446

</summary>

2447

<value>Value indicating if AspLogErrorRequests is enabled or disabled.</value>

2448

</member>

2449

2450

2451

The AspScriptErrorSentToBrowser property specifies whether the Web server writes

2452

debugging specifics (file name, error, line number, description) to the client

2453

browser, in addition to logging them to the Windows Event Log. The <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspScriptErrorMessage"/>

2454

property provides the error message to be sent if this property is set to false.

2455

</summary>

2456

<value>Value indicating if AspScriptErrorSentToBrowser is enabled or disabled.</value>

2457

</member>

2458

2459

2460

The AspTrackThreadingModel property specifies whether IIS checks the threading model

2461

of any components (COM objects) that your application creates. The preferred setting

2462

of this metabase property is false.

2463

</summary>

2464

<value>Value indicating if AspTrackThreadingModel is enabled or disabled.</value>

2465

</member>

2466

2467

2468

Specifies Anonymous authentication as one of the possible Windows authentication

2469

schemes returned to clients as being available.

2470

</summary>

2471

<value>Value indicating if AuthAnonymous is enabled or disabled.</value>

2472

</member>

2473

2474

2475

Specifies Basic authentication as one of the possible Windows authentication

2476

schemes returned to clients as being available.

2477

</summary>

2478

<value>Value indicating if AuthBasic is enabled or disabled.</value>

2479

</member>

2480

2481

2482

Specifies Integrated Windows authentication (also known as Challenge/Response or

2483

NTLM authentication) as one of the possible Windows authentication schemes

2484

returned to clients as being available.

2485

</summary>

2486

<value>Value indicating if AuthNtlm is enabled or disabled.</value>

2487

</member>

2488

2489

2490

Setting this flag to true specifies that authentication persists only for a single

2491

request on a connection. IIS resets the authentication at the end of each request, and

2492

forces re-authentication on the next request of the session.

2493

</summary>

2494

<value>Value indicating if AuthPersistSingleRequest is enabled or disabled.</value>

2495

</member>

2496

2497

2498

Setting this flag to true specifies authentication will persist only across single

2499

requests on a connection if the connection is by proxy. IIS will reset the authentication

2500

at the end of the request if the current authenticated request is by proxy and it is

2501

not the special case where IIS is running MSPROXY.

2502

</summary>

2503

<value>Value indicating if AuthPersistSingleRequestIfProxy is enabled or disabled.</value>

2504

</member>

2505

2506

2507

Setting this flag to true specifies that authentication is valid for a single request if

2508

by proxy. IIS will reset the authentication at the end of the request and force

2509

re-authentication on the next request if the current authenticated request is by

2510

proxy of any type.

2511

</summary>

2512

<value>Value indicating if AuthPersistSingleRequestAlwaysIfProxy is enabled or disabled.</value>

2513

</member>

2514

2515

2516

The CacheControlNoCache property specifies the HTTP 1.1 directive to prevent caching of content.

2517

</summary>

2518

<value>Value indicating if CacheControlNoCache is enabled or disabled.</value>

2519

</member>

2520

2521

2522

The CacheISAPI property indicates whether ISAPI extensions are cached in memory after first use.

2523

</summary>

2524

<value>Value indicating if CacheIsapi is enabled or disabled.</value>

2525

</member>

2526

2527

2528

The ContentIndexed property specifies whether the installed content indexer should

2529

index content under this directory tree.

2530

</summary>

2531

<value>Value indicating if ContentIndexed is enabled or disabled.</value>

2532

</member>

2533

2534

2535

This property specifies whether process accounting and throttling should be performed

2536

for ISAPI extensions and ASP applications. To perform process accounting on CGI

2537

applications, use the property <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CpuCgiEnabled"/>.

2538

</summary>

2539

<value>Value indicating if CpuAppEnabled is enabled or disabled.</value>

2540

</member>

2541

2542

2543

This property indicates whether IIS should perform process accounting for CGI

2544

applications. To effectively throttle CGI applications, use the CgiTimeout

2545

property. To use process accounting for ISAPI and ASP applications, use <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CpuAppEnabled"/>.

2546

</summary>

2547

<value>Value indicating if CpuCgiEnabled is enabled or disabled.</value>

2548

</member>

2549

2550

2551

The CreateCGIWithNewConsole property indicates whether a CGI application runs in its own console.

2552

</summary>

2553

<value>Value indicating if CreateCgiWithNewConsole is enabled or disabled.</value>

2554

</member>

2555

2556

2557

The CreateProcessAsUser property specifies whether a CGI process is created in the system context or in the context of the requesting user.

2558

</summary>

2559

<value>Value indicating if CreateProcessAsUser is enabled or disabled.</value>

2560

</member>

2561

2562

2563

When set to true, date information is displayed when browsing directories.

2564

</summary>

2565

<value>Value indicating if DirBrowseShowDate is enabled or disabled.</value>

2566

</member>

2567

2568

2569

When set to true, file name extensions are displayed when browsing directories.

2570

</summary>

2571

<value>Value indicating if DirBrowseShowExtension is enabled or disabled.</value>

2572

</member>

2573

2574

2575

When set to true, date information is displayed in extended format when displaying directories.

2576

</summary>

2577

<value>Value indicating if DirBrowseShowLongDate is enabled or disabled.</value>

2578

</member>

2579

2580

2581

When set to true, file size information is displayed when browsing directories.

2582

</summary>

2583

<value>Value indicating if DirBrowseShowSize is enabled or disabled.</value>

2584

</member>

2585

2586

2587

When set to true, file time information is displayed when displaying directories.

2588

</summary>

2589

<value>Value indicating if DirBrowseShowTime is enabled or disabled.</value>

2590

</member>

2591

2592

2593

The DontLog property specifies whether client requests are written to the IIS log files.

2594

</summary>

2595

<value>Value indicating if DontLog is enabled or disabled.</value>

2596

</member>

2597

2598

2599

When set to true, the default document (specified by the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DefaultDoc"/> property) for

2600

a directory is loaded when the directory is browsed.

2601

</summary>

2602

<value>Value indicating if EnableDefaultDoc is enabled or disabled.</value>

2603

</member>

2604

2605

2606

When set to true, directory browsing is enabled.

2607

</summary>

2608

<value>Value indicating if EnableDirBrowsing is enabled or disabled.</value>

2609

</member>

2610

2611

2612

The EnableDocFooter property enables or disables custom footers specified by

2613

the DefaultDocFooter property.

2614

</summary>

2615

<value>Value indicating if EnableDocFooter is enabled or disabled.</value>

2616

</member>

2617

2618

2619

The EnableReverseDns property enables or disables reverse Domain Name Server (DNS) lookups

2620

for the World Wide Web Publishing Service (WWW service). Reverse lookups involve looking

2621

up the domain name when the IP address is known. Reverse DNS lookups can use significant

2622

resources and time.

2623

</summary>

2624

<value>Value indicating if EnableReverseDns is enabled or disabled.</value>

2625

</member>

2626

2627

2628

The SSIExecDisable property specifies whether server-side include (SSI) #exec directives

2629

are disabled under this path.

2630

</summary>

2631

<value>Value indicating if SsiExecDisable is enabled or disabled.</value>

2632

</member>

2633

2634

2635

The UNCAuthenticationPassthrough property enables user authentication passthrough

2636

for Universal Naming Convention (UNC) virtual root access (for authentication schemes

2637

that support delegation).

2638

</summary>

2639

<value>Value indicating if UncAuthenticationPassthrough is enabled or disabled.</value>

2640

</member>

2641

2642

2643

The AspScriptErrorMessage property specifies the error message to send to the browser

2644

if specific debugging errors are not sent to the client (if <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspScriptErrorSentToBrowser"/>

2645

is set to false).

2646

</summary>

2647

<value>Value indicating if AspScriptErrorMessage is enabled or disabled.</value>

2648

</member>

2649

2650

2651

The DefaultDoc contains one or more file names of default documents that will be returned

2652

to the client if no file name is included in the client's request. The default document

2653

will be returned if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.EnableDefaultDoc"/> flag of the DirBrowseFlags property

2654

is set to true for the directory. This property can contain a list of default document

2655

file names separated by a comma and a space, for example Default.htm, Default.asp.

2656

</summary>

2657

<value>Listing of the default documents for the web application.</value>

2658

</member>

2659

2660

2661

Deletes an existing application pool on a local or remote machine with IIS installed. The default is

2662

to delete an existing application pool on the local machine. If connecting to a remote machine, you can

2663

specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task

2664

to run under.

2665

</summary>

2666

<example>Delete an existing application pool on the local machine.

2667

<code><![CDATA[

2668

2669

]]></code>

2670

</example>

2671

</member>

2672

2673

2674

When overridden in a derived class, executes the task.

2675

</summary>

2676

2677

True if the task successfully executed; otherwise, false.

2678

</returns>

2679

</member>

2680

2681

2682

Gets or sets the name of the application pool.

2683

</summary>

2684

<value>The name of the application pool.</value>

2685

</member>

2686

2687

2688

Deletes a web directory on a local or remote machine with IIS installed. The default is

2689

to delete the web directory on the local machine. If connecting to a remote machine, you

2690

can specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the

2691

task to run under.

2692

</summary>

2693

<example>Deletes a web directory on the local machine.

2694

<code><![CDATA[

2695

2696

]]></code>

2697

</example>

2698

</member>

2699

2700

2701

When overridden in a derived class, executes the task.

2702

</summary>

2703

2704

True if the task successfully executed; otherwise, false.

2705

</returns>

2706

</member>

2707

2708

2709

Gets or sets the name of the virtual directory.

2710

</summary>

2711

<value>The name of the virtual directory.</value>

2712

</member>

2713

2714

2715

Actions the <see cref="T:MSBuild.Community.Tasks.IIS.AppPoolController"/> can do.

2716

</summary>

2717

</member>

2718

2719

<summary>Start the applicaiton pool</summary>

2720

</member>

2721

2722

<summary>Stop the applicaiton pool</summary>

2723

</member>

2724

2725

<summary>Restart the applicaiton pool</summary>

2726

</member>

2727

2728

<summary>Recycle the applicaiton pool</summary>

2729

</member>

2730

2731

2732

Allows control for an application pool on a local or remote machine with IIS installed. The default is

2733

to control the application pool on the local machine. If connecting to a remote machine, you can

2734

specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task

2735

to run under.

2736

</summary>

2737

<example>Restart an application pool on the local machine.

2738

<code><![CDATA[

2739

2740

]]></code>

2741

</example>

2742

</member>

2743

2744

2745

When overridden in a derived class, executes the task.

2746

</summary>

2747

2748

True if the task successfully executed; otherwise, false.

2749

</returns>

2750

</member>

2751

2752

2753

Gets or sets the name of the app pool.

2754

</summary>

2755

2756

</member>

2757

2758

2759

Gets or sets the application pool action.

2760

</summary>

2761

<value>The application pool action.</value>

2762

2763

</member>

2764

2765

2766

Sends an email message

2767

</summary>

2768

<example>Example of sending an email.

2769

<code><![CDATA[

2770

2771

<Mail SmtpServer="localhost"

2772

To="user@email.com"

2773

From="from@email.com"

2774

Subject="Test Mail Task"

2775

Body="This is a test of the mail task." />

2776

</Target>

2777

]]></code>

2778

</example>

2779

</member>

2780

2781

2782

Initializes a new instance of the <see cref="T:Mail"/> class.

2783

</summary>

2784

</member>

2785

2786

<summary>Sends an email message</summary>

2787

<returns>Returns true if successful</returns>

2788

</member>

2789

2790

2791

List of files to attach to message

2792

</summary>

2793

</member>

2794

2795

2796

List of addresss that contains the blind carbon copy (BCC) recipients for this e-mail message

2797

</summary>

2798

</member>

2799

2800

2801

List of addresss that contains the carbon copy (CC) recipients for this e-mail message

2802

</summary>

2803

</member>

2804

2805

2806

The email message body

2807

</summary>

2808

</member>

2809

2810

2811

The from address for this e-mail message

2812

</summary>

2813

2814

This property is required.

2815

</remarks>

2816

</member>

2817

2818

2819

A value indicating whether the mail message body is in Html

2820

</summary>

2821

</member>

2822

2823

2824

The priority of this e-mail message

2825

</summary>

2826

2827

Possible values are High, Normal, and Low

2828

</remarks>

2829

</member>

2830

2831

2832

The subject line for this e-mail message

2833

</summary>

2834

2835

This property is required.

2836

</remarks>

2837

</member>

2838

2839

2840

The name or IP address of the host used for SMTP transactions

2841

</summary>

2842

2843

This property is required.

2844

</remarks>

2845

</member>

2846

2847

2848

List of addresss that contains the recipients of this e-mail message

2849

</summary>

2850

2851

This property is required.

2852

</remarks>

2853

</member>

2854

2855

2856

Gets or sets the username.

2857

</summary>

2858

<value>The username.</value>

2859

</member>

2860

2861

2862

Gets or sets the password.

2863

</summary>

2864

<value>The password.</value>

2865

</member>

2866

2867

2868

Add numbers

2869

</summary>

2870

<example>Adding numbers:

2871

<code><![CDATA[

2872

<Math.Add Numbers="4;3">

2873

2874

</Math.Add>

2875

2876

]]></code>

2877

</example>

2878

</member>

2879

2880

2881

Math task base class

2882

</summary>

2883

</member>

2884

2885

2886

When overridden in a derived class, executes the task.

2887

</summary>

2888

2889

true if the task successfully executed; otherwise, false.

2890

</returns>

2891

</member>

2892

2893

2894

Strings array to decimal array.

2895

</summary>

2896

<param name="numbers">The numbers.</param>

2897

2898

</member>

2899

2900

2901

Gets or sets the numbers to work with.

2902

</summary>

2903

<value>The numbers.</value>

2904

</member>

2905

2906

2907

Gets or sets the result.

2908

</summary>

2909

<value>The result.</value>

2910

</member>

2911

2912

2913

Gets or sets the numeric format.

2914

</summary>

2915

<value>The numeric format.</value>

2916

</member>

2917

2918

2919

When overridden in a derived class, executes the task.

2920

</summary>

2921

2922

true if the task successfully executed; otherwise, false.

2923

</returns>

2924

</member>

2925

2926

2927

Divide numbers

2928

</summary>

2929

2930

<code><![CDATA[

2931

<Math.Divide Numbers="1;2">

2932

2933

</Math.Divide>

2934

2935

]]></code>

2936

</example>

2937

</member>

2938

2939

2940

When overridden in a derived class, executes the task.

2941

</summary>

2942

2943

true if the task successfully executed; otherwise, false.

2944

</returns>

2945

</member>

2946

2947

2948

Multiple numbers

2949

</summary>

2950

2951

<code><![CDATA[

2952

<Math.Multiple Numbers="10;3">

2953

2954

</Math.Multiple>

2955

2956

]]></code>

2957

</example>

2958

</member>

2959

2960

2961

When overridden in a derived class, executes the task.

2962

</summary>

2963

2964

true if the task successfully executed; otherwise, false.

2965

</returns>

2966

</member>

2967

2968

2969

Subtract numbers

2970

</summary>

2971

2972

<code><![CDATA[

2973

<Math.Subtract Numbers="10;3">

2974

2975

</Math.Subtract>

2976

2977

]]></code>

2978

</example>

2979

</member>

2980

2981

2982

When overridden in a derived class, executes the task.

2983

</summary>

2984

2985

true if the task successfully executed; otherwise, false.

2986

</returns>

2987

</member>

2988

2989

2990

Moves files on the filesystem to a new location.

2991

</summary>

2992

2993

<para>Move a file to another folder</para>

2994

<code><![CDATA[

2995

<Move SourceFiles="Test\MoveMe.txt"

2996

DestinationFolder="Test\Move" />

2997

]]></code>

2998

<para>Rename a file</para>

2999

<code><![CDATA[

3000

<Move SourceFiles="Test\Move\MoveMe.txt"

3001

DestinationFiles="Test\Move\Renamed.txt" />

3002

]]></code>

3003

</example>

3004

</member>

3005

3006

3007

When overridden in a derived class, executes the task.

3008

</summary>

3009

3010

true if the task successfully executed; otherwise, false.

3011

</returns>

3012

</member>

3013

3014

3015

Gets the items that were successfully moved.

3016

</summary>

3017

<value>The moved files.</value>

3018

</member>

3019

3020

3021

Gets or sets the list of files to moved the source files to.

3022

</summary>

3023

3024

This list is expected to be a one-to-one mapping with the

3025

list specified in the SourceFiles parameter. That is, the

3026

first file specified in SourceFiles will be moved to the

3027

first location specified in DestinationFiles, and so forth.

3028

</remarks>

3029

<value>The destination files.</value>

3030

</member>

3031

3032

3033

Gets or sets the directory to which you want to move the files.

3034

</summary>

3035

<value>The destination folder.</value>

3036

</member>

3037

3038

3039

Gets or sets the source files to move.

3040

</summary>

3041

<value>The source files to move.</value>

3042

</member>

3043

3044

3045

Runs the NDoc application.

3046

</summary>

3047

<example>Generated html help file.

3048

<code><![CDATA[

3049

<NDoc Documenter="MSDN"

3050

ProjectFilePath="MSBuild.Community.Tasks.ndoc" />

3051

]]></code>

3052

</example>

3053

</member>

3054

3055

3056

Initializes a new instance of the <see cref="T:NDoc"/> class.

3057

</summary>

3058

</member>

3059

3060

3061

Returns a string value containing the command line arguments to pass directly to the executable file.

3062

</summary>

3063

3064

A string value containing the command line arguments to pass directly to the executable file.

3065

</returns>

3066

</member>

3067

3068

3069

Returns the fully qualified path to the executable file.

3070

</summary>

3071

3072

The fully qualified path to the executable file.

3073

</returns>

3074

</member>

3075

3076

3077

Logs the starting point of the run to all registered loggers.

3078

</summary>

3079

<param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>

3080

</member>

3081

3082

3083

Returns the directory in which to run the executable file.

3084

</summary>

3085

3086

The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.

3087

</returns>

3088

</member>

3089

3090

3091

Gets or sets the documenter.

3092

</summary>

3093

<value>The documenter.</value>

3094

<remarks>Available documenters are VS.NET_2003, JavaDoc, LaTeX, LinearHtml, MSDN, XML.</remarks>

3095

</member>

3096

3097

3098

Gets or sets the project file path.

3099

</summary>

3100

<value>The project file path.</value>

3101

</member>

3102

3103

3104

Gets or sets a value indicating whether the output is verbose.

3105

</summary>

3106

<value><c>true</c> if verbose; otherwise, <c>false</c>.</value>

3107

</member>

3108

3109

3110

Gets or sets the working directory.

3111

</summary>

3112

<value>The working directory.</value>

3113

3114

The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.

3115

</returns>

3116

</member>

3117

3118

3119

Gets the name of the executable file to run.

3120

</summary>

3121

3122

<returns>The name of the executable file to run.</returns>

3123

</member>

3124

3125

3126

Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.

3127

</summary>

3128

3129

<returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>

3130

</member>

3131

3132

3133

Run NUnit on a group of assemblies.

3134

</summary>

3135

<example>Run NUnit tests.

3136

<code><![CDATA[

3137

3138

3139

</ItemGroup>

3140

3141

3142

</Target>

3143

]]></code>

3144

</example>

3145

</member>

3146

3147

3148

The default relative path of the NUnit installation.

3149

The value is <c>@"NUnit-Net-2.0 2.2.5\bin"</c>.

3150

</summary>

3151

</member>

3152

3153

3154

Initializes a new instance of the <see cref="T:NUnit"/> class.

3155

</summary>

3156

</member>

3157

3158

3159

Returns a string value containing the command line arguments to pass directly to the executable file.

3160

</summary>

3161

3162

A string value containing the command line arguments to pass directly to the executable file.

3163

</returns>

3164

</member>

3165

3166

3167

Returns the fully qualified path to the executable file.

3168

</summary>

3169

3170

The fully qualified path to the executable file.

3171

</returns>

3172

</member>

3173

3174

3175

Logs the starting point of the run to all registered loggers.

3176

</summary>

3177

<param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>

3178

</member>

3179

3180

3181

Returns the directory in which to run the executable file.

3182

</summary>

3183

3184

The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.

3185

</returns>

3186

</member>

3187

3188

3189

Gets or sets the assemblies.

3190

</summary>

3191

<value>The assemblies.</value>

3192

</member>

3193

3194

3195

Gets or sets the include category.

3196

</summary>

3197

<value>The include category.</value>

3198

</member>

3199

3200

3201

Gets or sets the exclude category.

3202

</summary>

3203

<value>The exclude category.</value>

3204

</member>

3205

3206

3207

Gets or sets the fixture.

3208

</summary>

3209

<value>The fixture.</value>

3210

</member>

3211

3212

3213

Gets or sets the XSLT transform file.

3214

</summary>

3215

<value>The XSLT transform file.</value>

3216

</member>

3217

3218

3219

Gets or sets the output XML file.

3220

</summary>

3221

<value>The output XML file.</value>

3222

</member>

3223

3224

3225

Gets or sets the working directory.

3226

</summary>

3227

<value>The working directory.</value>

3228

3229

The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.

3230

</returns>

3231

</member>

3232

3233

3234

Gets the name of the executable file to run.

3235

</summary>

3236

3237

<returns>The name of the executable file to run.</returns>

3238

</member>

3239

3240

3241

Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.

3242

</summary>

3243

3244

<returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>

3245

</member>

3246

3247

3248

A strongly-typed resource class, for looking up localized strings, etc.

3249

</summary>

3250

</member>

3251

3252

3253

Returns the cached ResourceManager instance used by this class.

3254

</summary>

3255

</member>

3256

3257

3258

Overrides the current thread's CurrentUICulture property for all

3259

resource lookups using this strongly typed resource class.

3260

</summary>

3261

</member>

3262

3263

3264

Looks up a localized string similar to Attrib directory '{0}'. {1}.

3265

</summary>

3266

</member>

3267

3268

3269

Looks up a localized string similar to Attrib file '{0}'. {1}.

3270

</summary>

3271

</member>

3272

3273

3274

Looks up a localized string similar to File Not Found: {0}.

3275

</summary>

3276

</member>

3277

3278

3279

Looks up a localized string similar to Local File Not Found: {0}.

3280

</summary>

3281

</member>

3282

3283

3284

Looks up a localized string similar to {0}% Complete ({1}).

3285

</summary>

3286

</member>

3287

3288

3289

Looks up a localized string similar to Transfered {0} ({1}) in {2}.

3290

</summary>

3291

</member>

3292

3293

3294

Looks up a localized string similar to Upload File Complete, {0}.

3295

</summary>

3296

</member>

3297

3298

3299

Looks up a localized string similar to Uploading "{0}"

3300

to "{1}"

3301

3302

</summary>

3303

</member>

3304

3305

3306

Looks up a localized string similar to The URI "{0}" scheme is not valid..

3307

</summary>

3308

</member>

3309

3310

3311

Looks up a localized string similar to Emailing "{0}"..

3312

</summary>

3313

</member>

3314

3315

3316

Looks up a localized string similar to "{0}" is not a number..

3317

</summary>

3318

</member>

3319

3320

3321

Looks up a localized string similar to Creating directory "{0}"..

3322

</summary>

3323

</member>

3324

3325

3326

Looks up a localized string similar to Could not move the file "{0}" to the destination file "{1}", because the destination is a folder instead of a file. To move the source file into a folder, consider using the DestinationFolder parameter instead of DestinationFiles..

3327

</summary>

3328

</member>

3329

3330

3331

Looks up a localized string similar to Unable to move file "{0}" to "{1}". {2}.

3332

</summary>

3333

</member>

3334

3335

3336

Looks up a localized string similar to Both "{0}" and "{1}" were specified as input parameters in the project file. Please choose one or the other..

3337

</summary>

3338

</member>

3339

3340

3341

Looks up a localized string similar to Moving file from "{0}" to "{1}"..

3342

</summary>

3343

</member>

3344

3345

3346

Looks up a localized string similar to No destination specified for Move. Please supply either "{0}" or "{1}"..

3347

</summary>

3348

</member>

3349

3350

3351

Looks up a localized string similar to The source file "{0}" is actually a directory. The "Move" task does not support moving directories..

3352

</summary>

3353

</member>

3354

3355

3356

Looks up a localized string similar to Could not find the NUnit Project File open command. Please make sure NUnit is installed..

3357

</summary>

3358

</member>

3359

3360

3361

Looks up a localized string similar to The "{0}" task was not given a value for the required parameter "{1}"..

3362

</summary>

3363

</member>

3364

3365

3366

Looks up a localized string similar to Read Windows Registry.

3367

</summary>

3368

</member>

3369

3370

3371

Looks up a localized string similar to Write Windows Registry.

3372

</summary>

3373

</member>

3374

3375

3376

Looks up a localized string similar to Cannot continue service {0} on computer '{1}' as it does not support the pause and continue..

3377

</summary>

3378

</member>

3379

3380

3381

Looks up a localized string similar to Cannot pause service {0} on computer '{1}' as it does not support the pause and continue..

3382

</summary>

3383

</member>

3384

3385

3386

Looks up a localized string similar to Cannot stop service {0} on computer '{1}'..

3387

</summary>

3388

</member>

3389

3390

3391

Looks up a localized string similar to {0} service was continued successfully..

3392

</summary>

3393

</member>

3394

3395

3396

Looks up a localized string similar to {0} service is continuing ....

3397

</summary>

3398

</member>

3399

3400

3401

Looks up a localized string similar to Couldn't find the '{0}' service on '{1}'.

3402

</summary>

3403

</member>

3404

3405

3406

Looks up a localized string similar to Cannot continue service {0} on computer '{1}' as its not currently paused..

3407

</summary>

3408

</member>

3409

3410

3411

Looks up a localized string similar to Cannot pause service {0} on computer '{1}' as its not currently started..

3412

</summary>

3413

</member>

3414

3415

3416

Looks up a localized string similar to {0} service was paused successfully..

3417

</summary>

3418

</member>

3419

3420

3421

Looks up a localized string similar to {0} service is pausing ....

3422

</summary>

3423

</member>

3424

3425

3426

Looks up a localized string similar to {0} service was started successfully..

3427

</summary>

3428

</member>

3429

3430

3431

Looks up a localized string similar to {0} service is starting ....

3432

</summary>

3433

</member>

3434

3435

3436

Looks up a localized string similar to The '{0}' service on '{1}' is '{2}'..

3437

</summary>

3438

</member>

3439

3440

3441

Looks up a localized string similar to {0} service was stopped successfully..

3442

</summary>

3443

</member>

3444

3445

3446

Looks up a localized string similar to {0} service is stopping ....

3447

</summary>

3448

</member>

3449

3450

3451

Looks up a localized string similar to LocalPath is not a working subversion copy..

3452

</summary>

3453

</member>

3454

3455

3456

Looks up a localized string similar to Failed to get current date!.

3457

</summary>

3458

</member>

3459

3460

3461

Looks up a localized string similar to Getting current date..

3462

</summary>

3463

</member>

3464

3465

3466

Looks up a localized string similar to "{2}" refers to {0} item(s), and "{3}" refers to {1} item(s). They must have the same number of items..

3467

</summary>

3468

</member>

3469

3470

3471

Looks up a localized string similar to extracted "{0}".

3472

</summary>

3473

</member>

3474

3475

3476

Looks up a localized string similar to Unzip File "{0}"

3477

to Directory "{1}"

3478

3479

</summary>

3480

</member>

3481

3482

3483

Looks up a localized string similar to Unzipped file "{0}" successfully..

3484

</summary>

3485

</member>

3486

3487

3488

Looks up a localized string similar to Version file "{0}" not found ..

3489

</summary>

3490

</member>

3491

3492

3493

Looks up a localized string similar to Version "{0}" read from file "{1}"..

3494

</summary>

3495

</member>

3496

3497

3498

Looks up a localized string similar to Unable to read version number from "{0}". {1}.

3499

</summary>

3500

</member>

3501

3502

3503

Looks up a localized string similar to Unable to write version number to "{0}". {1}".

3504

</summary>

3505

</member>

3506

3507

3508

Looks up a localized string similar to Version "{0}" wrote to file "{1}"..

3509

</summary>

3510

</member>

3511

3512

3513

Looks up a localized string similar to Reading Xml Document "{0}"..

3514

</summary>

3515

</member>

3516

3517

3518

Looks up a localized string similar to {0} node(s) selected for read..

3519

</summary>

3520

</member>

3521

3522

3523

Looks up a localized string similar to XmlRead Result: "{0}".

3524

</summary>

3525

</member>

3526

3527

3528

Looks up a localized string similar to Updating Xml Document "{0}"..

3529

</summary>

3530

</member>

3531

3532

3533

Looks up a localized string similar to {0} node(s) selected for update..

3534

</summary>

3535

</member>

3536

3537

3538

Looks up a localized string similar to XmlUpdate Wrote: "{0}".

3539

</summary>

3540

</member>

3541

3542

3543

Looks up a localized string similar to Adding Parameter \"{0}\": \"{1}\".

3544

</summary>

3545

</member>

3546

3547

3548

Looks up a localized string similar to Adding root attribute {0}=\"{1}\".

3549

</summary>

3550

</member>

3551

3552

3553

Looks up a localized string similar to Creating root tag \"{0}\".

3554

</summary>

3555

</member>

3556

3557

3558

Looks up a localized string similar to No input files.

3559

</summary>

3560

</member>

3561

3562

3563

Looks up a localized string similar to No root tag inserted.

3564

</summary>

3565

</member>

3566

3567

3568

Looks up a localized string similar to added "{0}".

3569

</summary>

3570

</member>

3571

3572

3573

Looks up a localized string similar to Creating zip file "{0}"..

3574

</summary>

3575

</member>

3576

3577

3578

Looks up a localized string similar to Zip File Not Found: {0}.

3579

</summary>

3580

</member>

3581

3582

3583

Looks up a localized string similar to Created zip file "{0}" successfully..

3584

</summary>

3585

</member>

3586

3587

3588

Reads a value from the Registry

3589

</summary>

3590

<example>Read .NET Framework install root from Registry.

3591

<code><![CDATA[

3592

<RegistryRead

3593

KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework"

3594

ValueName="InstallRoot">

3595

3596

</RegistryRead>

3597

3598

]]></code>

3599

</example>

3600

</member>

3601

3602

3603

Initializes a new instance of the <see cref="T:RegistryRead"/> class.

3604

</summary>

3605

</member>

3606

3607

3608

When overridden in a derived class, executes the task.

3609

</summary>

3610

3611

true if the task successfully executed; otherwise, false.

3612

</returns>

3613

</member>

3614

3615

3616

Gets or sets the full registry path of the key, beginning with a valid registry root, such as "HKEY_CURRENT_USER".

3617

</summary>

3618

3619

</member>

3620

3621

3622

Gets or sets the name of the name/value pair.

3623

</summary>

3624

<value>The name of the value.</value>

3625

</member>

3626

3627

3628

Gets or sets the default value.

3629

</summary>

3630

<value>The default value.</value>

3631

</member>

3632

3633

3634

Gets the stored value.

3635

</summary>

3636

<value>The value.</value>

3637

</member>

3638

3639

3640

Writes a value to the Registry

3641

</summary>

3642

<example>Write a value to Registry

3643

<code><![CDATA[

3644

<RegistryWrite

3645

KeyName="HKEY_CURRENT_USER\SOFTWARE\MSBuildTasks"

3646

ValueName="RegistryWrite"

3647

Value="Test Write" />

3648

]]></code>

3649

</example>

3650

</member>

3651

3652

3653

Initializes a new instance of the <see cref="T:RegistryWrite"/> class.

3654

</summary>

3655

</member>

3656

3657

3658

When overridden in a derived class, executes the task.

3659

</summary>

3660

3661

true if the task successfully executed; otherwise, false.

3662

</returns>

3663

</member>

3664

3665

3666

Gets or sets the full registry path of the key, beginning with a valid registry root, such as "HKEY_CURRENT_USER".

3667

</summary>

3668

3669

</member>

3670

3671

3672

Gets or sets the name of the name/value pair.

3673

</summary>

3674

<value>The name of the value.</value>

3675

</member>

3676

3677

3678

Gets or sets the value to be stored.

3679

</summary>

3680

<value>The value.</value>

3681

</member>

3682

3683

3684

Executes code contained within the task.

3685

</summary>

3686

3687

<para>Simple script that writes to the console</para>

3688

<code><![CDATA[

3689

3690

3691

<![CDATA[

3692

public static void ScriptMain() {

3693

Console.WriteLine("Hello MSBuild Community Scripting World.");

3694

}

3695

]] >

3696

</HelloCode>

3697

</PropertyGroup>

3698

3699

3700

</Target>

3701

]]></code>

3702

</example>

3703

</member>

3704

3705

3706

Executes the task.

3707

</summary>

3708

<returns><see langword="true"/> if the task ran successfully;

3709

otherwise <see langword="false"/>.</returns>

3710

</member>

3711

3712

3713

The required references

3714

</summary>

3715

</member>

3716

3717

3718

The namespaces to import.

3719

</summary>

3720

</member>

3721

3722

3723

The language of the script block (defaults to C#).

3724

</summary>

3725

<remarks><para>The supported languages are:</para>

3726

3727

<item><description>Visual Basic.NET (VB, vb, VISUALBASIC)</description></item>

3728

<item><description>C# (C#, c#, CSHARP)</description></item>

3729

<item><description>JavaScript (JS, js, JSCRIPT)</description></item>

3730

<item><description>J# (VJS, vjs, JSHARP)</description></item>

3731

</list> or, proviude the fully-qualified name for a class implementing

3732

3733

</member>

3734

3735

3736

The name of the main class containing the static <c>ScriptMain</c>

3737

entry point.

3738

</summary>

3739

</member>

3740

3741

3742

THe code to compile and execute

3743

</summary>

3744

</member>

3745

3746

3747

A task for sleeping for a specified period of time.

3748

</summary>

3749

<example>Causes the build to sleep for 300 milliseconds.

3750

<code><![CDATA[

3751

3752

]]></code>

3753

</example>

3754

</member>

3755

3756

3757

Executes the task.

3758

</summary>

3759

<returns><see langword="true"/> if the task ran successfully;

3760

otherwise <see langword="false"/>.</returns>

3761

</member>

3762

3763

3764

The number of milliseconds to add to the time to sleep.

3765

</summary>

3766

</member>

3767

3768

3769

The number of seconds to add to the time to sleep.

3770

</summary>

3771

</member>

3772

3773

3774

The number of minutes to add to the time to sleep.

3775

</summary>

3776

</member>

3777

3778

3779

The number of hours to add to the time to sleep.

3780

</summary>

3781

</member>

3782

3783

3784

Base class for all of the Visual SourceSafe tasks.

3785

</summary>

3786

</member>

3787

3788

3789

Attempts to connect to the SourceSafe Database and

3790

load the specified item, or version of the item, if specified.

3791

</summary>

3792

</member>

3793

3794

3795

Reserved.

3796

</summary>

3797

<returns>Reserved.</returns>

3798

</member>

3799

3800

3801

Logs an exception using the MSBuild logging framework.

3802

</summary>

3803

3804

</member>

3805

3806

3807

The path to the folder that contains the srcsafe.ini file.

3808

</summary>

3809

</member>

3810

3811

3812

The Visual SourceSafe project or file to perform the action

3813

on (starts with "$/").

3814

</summary>

3815

</member>

3816

3817

3818

The name of the user accessing the SourceSafe database.

3819

</summary>

3820

</member>

3821

3822

3823

A version of the <see cref="P:MSBuild.Community.Tasks.SourceSafe.VssBase.Path"/> to reference.

3824

</summary>

3825

</member>

3826

3827

3828

The password to use to log in to SourceSafe.

3829

</summary>

3830

</member>

3831

3832

3833

Represents the VSS Database

3834

</summary>

3835

</member>

3836

3837

3838

Represents the VSS item selected (file or project).

3839

</summary>

3840

</member>

3841

3842

3843

Task that executes a checkin against a VSS Database.

3844

</summary>

3845

3846

3847

<code><![CDATA[<VssCheckin UserName="ccnet_build"

3848

Password="build"

3849

LocalPath="C:\Dev\MyProjects\Project\TestFile.cs"

3850

Recursive="False"

3851

DatabasePath="\\VSSServer\VSS\srcsafe.ini"

3852

Path="$/Test/TestFile.cs"

3853

3854

]]></code>

3855

</example>

3856

</member>

3857

3858

3859

Base class for VSS tasks that can act recursively.

3860

</summary>

3861

</member>

3862

3863

3864

Reserved.

3865

</summary>

3866

<returns>Reserved.</returns>

3867

</member>

3868

3869

3870

Determines whether to perform the SourceSafe operation

3871

recursively. The default is <see langword="true"/>.

3872

</summary>

3873

</member>

3874

3875

3876

Executes the task.

3877

</summary>

3878

<returns><see langword="true"/> if the task ran successfully;

3879

otherwise <see langword="false"/>.</returns>

3880

</member>

3881

3882

3883

The path to the local working directory.

3884

</summary>

3885

</member>

3886

3887

3888

Determines whether to leave the file(s) as writable once the

3889

checkin is complete. The default is <see langword="false"/>.

3890

</summary>

3891

</member>

3892

3893

3894

The checkin comment.

3895

</summary>

3896

</member>

3897

3898

3899

Task that executes a checkout of files or projects

3900

against a Visual SourceSafe database.

3901

</summary>

3902

3903

3904

<code><![CDATA[<VssCheckout UserName="ccnet_build"

3905

Password="build"

3906

LocalPath="C:\Dev\MyProjects\Project"

3907

Recursive="False"

3908

DatabasePath="\\VSSServer\VSS\srcsafe.ini"

3909

Path="$/Test/TestFile.cs"

3910

3911

]]></code>

3912

</example>

3913

</member>

3914

3915

3916

Executes the task.

3917

</summary>

3918

<returns><see langword="true"/> if the task ran successfully;

3919

otherwise <see langword="false"/>.</returns>

3920

</member>

3921

3922

3923

The path to the local working directory.

3924

</summary>

3925

</member>

3926

3927

3928

Determines whether files will be writable once retrieved from

3929

the repository. The default is <see langword="false"/>.

3930

</summary>

3931

</member>

3932

3933

3934

Task that adds files to a Visual SourceSafe database.

3935

</summary>

3936

</member>

3937

3938

3939

Executes the task.

3940

</summary>

3941

<returns><see langword="true"/> if the task ran successfully;

3942

otherwise <see langword="false"/>.</returns>

3943

</member>

3944

3945

3946

List of files that should be added to SourceSafe.

3947

</summary>

3948

</member>

3949

3950

3951

The comment to be applied to the newly added file.

3952

</summary>

3953

</member>

3954

3955

3956

Task that records differences between the latest version

3957

of all the items in a Visual SourceSafe project and another version or label

3958

to a file.

3959

</summary>

3960

3961

<para>Generates a file containing all of the differences between the

3962

current version and the label "Test Label"</para>

3963

<code><![CDATA[<VssDiff UserName="uid"

3964

Password="pwd"

3965

DatabasePath="\\VSSServer\VSS2\srcsafe.ini"

3966

Path="$/Test"

3967

OutputFile="Diff.xml"

3968

Label="Test Label"

3969

/>]]></code>

3970

</example>

3971

</member>

3972

3973

3974

Executes the task.

3975

</summary>

3976

<returns><see langword="true"/> if the task ran successfully;

3977

otherwise <see langword="false"/>.</returns>

3978

</member>

3979

3980

3981

The value of the label to compare to.

3982

</summary>

3983

</member>

3984

3985

3986

The name of the file to send the output to.

3987

</summary>

3988

</member>

3989

3990

3991

Task that retireves an item or project from a Visual SourceSafe database.

3992

</summary>

3993

3994

<para>Get the latest version (recursive) of a file from a VSS database and place

3995

in the specified local folder.</para>

3996

<code><![CDATA[

3997

<VssGet UserName="user"

3998

Password="password"

3999

LocalPath="C:\Dev\MyProjects\Project"

4000

Recursive="True"

4001

DatabasePath="\\VSSServer\VSS\srcsafe.ini"

4002

Path="$/Project"

4003

]]></code>

4004

</example>

4005

</member>

4006

4007

4008

Runs the task using the specified parameters.

4009

</summary>

4010

<returns><see langword="true"/> if the task ran successfully;

4011

otherwise <see langword="false"/>.</returns>

4012

</member>

4013

4014

4015

The path to the local working directory.

4016

</summary>

4017

</member>

4018

4019

4020

Determines whether to replace writable files.

4021

The default is <see langword="false"/>.

4022

</summary>

4023

</member>

4024

4025

4026

Determines whether files will be writable once retrieved from

4027

the repository. The default is <see langword="false"/>.

4028

</summary>

4029

</member>

4030

4031

4032

Generates an XML file containing details of all changes made

4033

to a Visual SourceSafe project or file between specified labels or dates.

4034

</summary>

4035

4036

<para>Generates a file containing details of all the changes made to the <c>$/Test</c>

4037

project by a user called joe.bloggs</para>

4038

<code><![CDATA[<VssHistory UserName="uid"

4039

Password="pwd"

4040

DatabasePath="\\VSSServer\VSS\srcsafe.ini"

4041

Path="$/Test"

4042

User="joe.bloggs"

4043

OutputFile="History.xml"

4044

Recursive="True"

4045

4046

]]></code>

4047

</example>

4048

4049

<para>Generates a file containing details of all the changes made between the

4050

labels Build1 and Build2 in the <c>$/Test</c> project.</para>

4051

<code><![CDATA[<VssHistory UserName="uid"

4052

Password="pwd"

4053

DatabasePath="\\VSSServer\VSS\srcsafe.ini"

4054

Path="$/Test"

4055

FromLabel="Build1"

4056

ToLabel="Build2"

4057

OutputFile="History.xml"

4058

Recursive="True"

4059

4060

]]></code>

4061

</example>

4062

4063

<para>Generates a file containing details of all the changes made between the

4064

1st December 2005 and 10th December 2005in the <c>$/Test</c> project.</para>

4065

<code><![CDATA[<VssHistory UserName="uid"

4066

Password="pwd"

4067

DatabasePath="\\VSSServer\VSS\srcsafe.ini"

4068

Path="$/Test"

4069

FromDate="2005-12-01 00:00"

4070

ToDate="2005-12-10 00:00"

4071

OutputFile="History.xml"

4072

Recursive="True"

4073

4074

]]></code>

4075

</example>

4076

</member>

4077

4078

4079

Executes the task.

4080

</summary>

4081

<returns><see langword="true"/> if the task ran successfully;

4082

otherwise <see langword="false"/>.</returns>

4083

</member>

4084

4085

4086

The label to start comparing to.

4087

</summary>

4088

</member>

4089

4090

4091

The label to compare up to.

4092

</summary>

4093

</member>

4094

4095

4096

The Start Date for the history.

4097

</summary>

4098

</member>

4099

4100

4101

The End Date for the history.

4102

</summary>

4103

</member>

4104

4105

4106

The name and path of the XML output file.

4107

</summary>

4108

</member>

4109

4110

4111

The name of the user whose changes should be listed in

4112

the history.

4113

</summary>

4114

</member>

4115

4116

4117

Task that applies a label to a Visual SourceSafe item.

4118

</summary>

4119

</member>

4120

4121

4122

Executes the task.

4123

</summary>

4124

<returns><see langword="true"/> if the task ran successfully;

4125

otherwise <see langword="false"/>.</returns>

4126

</member>

4127

4128

4129

The text of the label.

4130

</summary>

4131

</member>

4132

4133

4134

An optional comment.

4135

</summary>

4136

</member>

4137

4138

4139

Task that undoes a checkout of files or projects

4140

against a Visual SourceSafe database.

4141

</summary>

4142

4143

4144

<code><![CDATA[<VssUndoCheckout UserName="ccnet_build"

4145

Password="build"

4146

LocalPath="C:\Dev\MyProjects\Project"

4147

Recursive="False"

4148

DatabasePath="\\VSSServer\VSS\srcsafe.ini"

4149

Path="$/Test/TestFile.cs"

4150

4151

]]></code>

4152

</example>

4153

</member>

4154

4155

4156

Executes the task.

4157

</summary>

4158

<returns><see langword="true"/> if the task ran successfully;

4159

otherwise <see langword="false"/>.</returns>

4160

</member>

4161

4162

4163

The path to the local working directory.

4164

</summary>

4165

</member>

4166

4167

4168

Executes a SQL command.

4169

</summary>

4170

</member>

4171

4172

4173

When overridden in a derived class, executes the task.

4174

</summary>

4175

4176

true if the task successfully executed; otherwise, false.

4177

</returns>

4178

</member>

4179

4180

4181

The connection string

4182

</summary>

4183

</member>

4184

4185

4186

The command to execute

4187

</summary>

4188

</member>

4189

4190

4191

Output the return count/value

4192

</summary>

4193

</member>

4194

4195

4196

Checkout a local working copy of a Subversion repository.

4197

</summary>

4198

<example>Checkout a working copy

4199

<code><![CDATA[

4200

4201

4202

<SvnCheckout RepositoryPath="file:///d:/svn/repo/Test/trunk"

4203

LocalPath="$(MSBuildProjectDirectory)\Test\Checkout">

4204

4205

</SvnCheckout>

4206

4207

</Target>

4208

]]></code>

4209

</example>

4210

</member>

4211

4212

4213

Initializes a new instance of the <see cref="T:SvnCheckout"/> class.

4214

</summary>

4215

</member>

4216

4217

4218

Indicates whether all task paratmeters are valid.

4219

</summary>

4220

4221

true if all task parameters are valid; otherwise, false.

4222

</returns>

4223

</member>

4224

4225

4226

Subversion Commit command

4227

</summary>

4228

</member>

4229

4230

4231

Initializes a new instance of the <see cref="T:SvnCommit"/> class.

4232

</summary>

4233

</member>

4234

4235

4236

Indicates whether all task paratmeters are valid.

4237

</summary>

4238

4239

true if all task parameters are valid; otherwise, false.

4240

</returns>

4241

</member>

4242

4243

4244

Export a folder from a Subversion repository

4245

</summary>

4246

<example> Export from repository

4247

<code><![CDATA[

4248

4249

4250

4251

<SvnExport RepositoryPath="file:///d:/svn/repo/Test/trunk"

4252

LocalPath="$(MSBuildProjectDirectory)\Test\Export">

4253

4254

</SvnExport>

4255

4256

</Target>

4257

]]></code>

4258

</example>

4259

</member>

4260

4261

4262

Initializes a new instance of the <see cref="T:SvnExport"/> class.

4263

</summary>

4264

</member>

4265

4266

4267

Indicates whether all task paratmeters are valid.

4268

</summary>

4269

4270

true if all task parameters are valid; otherwise, false.

4271

</returns>

4272

</member>

4273

4274

4275

Summarize the local revision(s) of a working copy.

4276

</summary>

4277

<example>The following example gets the revision of the current folder.

4278

<code><![CDATA[

4279

4280

4281

4282

</SvnVersion>

4283

4284

</Target>

4285

]]></code>

4286

</example>

4287

</member>

4288

4289

4290

Initializes a new instance of the <see cref="T:SvnVersion"/> class.

4291

</summary>

4292

</member>

4293

4294

4295

Returns the fully qualified path to the executable file.

4296

</summary>

4297

4298

The fully qualified path to the executable file.

4299

</returns>

4300

</member>

4301

4302

4303

Logs the starting point of the run to all registered loggers.

4304

</summary>

4305

<param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>

4306

</member>

4307

4308

4309

Returns a string value containing the command line arguments to pass directly to the executable file.

4310

</summary>

4311

4312

A string value containing the command line arguments to pass directly to the executable file.

4313

</returns>

4314

</member>

4315

4316

4317

Runs the exectuable file with the specified task parameters.

4318

</summary>

4319

4320

true if the task runs successfully; otherwise, false.

4321

</returns>

4322

</member>

4323

4324

4325

Logs the events from text output.

4326

</summary>

4327

<param name="singleLine">The single line.</param>

4328

<param name="messageImportance">The message importance.</param>

4329

</member>

4330

4331

<summary>Path to local working copy.</summary>

4332

</member>

4333

4334

<summary>Revision number of the local working repository.</summary>

4335

</member>

4336

4337

<summary>High revision number of the local working repository revision range.</summary>

4338

</member>

4339

4340

<summary>Low revision number of the local working repository revision range.</summary>

4341

</member>

4342

4343

<summary>True if working copy contains modifications.</summary>

4344

</member>

4345

4346

<summary>True if working copy is switched.</summary>

4347

</member>

4348

4349

4350

True if invoked on a directory that is not a working copy,

4351

svnversion assumes it is an exported working copy and prints "exported".

4352

</summary>

4353

</member>

4354

4355

4356

Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.

4357

</summary>

4358

4359

<returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>

4360

</member>

4361

4362

4363

Gets the name of the executable file to run.

4364

</summary>

4365

4366

<returns>The name of the executable file to run.</returns>

4367

</member>

4368

4369

4370

Subversion Update command

4371

</summary>

4372

</member>

4373

4374

4375

Initializes a new instance of the <see cref="T:SvnUpdate"/> class.

4376

</summary>

4377

</member>

4378

4379

4380

Indicates whether all task paratmeters are valid.

4381

</summary>

4382

4383

true if all task parameters are valid; otherwise, false.

4384

</returns>

4385

</member>

4386

4387

4388

Unzip a file to a target directory.

4389

</summary>

4390

<example>Unzip file tasks

4391

<code><![CDATA[

4392

<Unzip ZipFileName="MSBuild.Community.Tasks.zip"

4393

TargetDirectory="Backup"/>

4394

]]></code>

4395

</example>

4396

</member>

4397

4398

4399

Initializes a new instance of the <see cref="T:Unzip"/> class.

4400

</summary>

4401

</member>

4402

4403

4404

When overridden in a derived class, executes the task.

4405

</summary>

4406

4407

true if the task successfully executed; otherwise, false.

4408

</returns>

4409

</member>

4410

4411

4412

Gets or sets the name of the zip file.

4413

</summary>

4414

4415

</member>

4416

4417

4418

Gets or sets the target directory.

4419

</summary>

4420

<value>The target directory.</value>

4421

</member>

4422

4423

4424

TODO Not Complete ...

4425

</summary>

4426

</member>

4427

4428

4429

Get Version information from file.

4430

</summary>

4431

<example>Get version information and increment revision.

4432

<code><![CDATA[

4433

4434

4435

4436

4437

4438

</Version>

4439

4440

]]></code>

4441

</example>

4442

</member>

4443

4444

4445

Initializes a new instance of the <see cref="T:Version"/> class.

4446

</summary>

4447

</member>

4448

4449

4450

When overridden in a derived class, executes the task.

4451

</summary>

4452

4453

true if the task successfully executed; otherwise, false.

4454

</returns>

4455

</member>

4456

4457

4458

Gets or sets the major version number.

4459

</summary>

4460

<value>The major version number.</value>

4461

</member>

4462

4463

4464

Gets or sets the minor version number.

4465

</summary>

4466

<value>The minor version number.</value>

4467

</member>

4468

4469

4470

Gets or sets the build version number.

4471

</summary>

4472

<value>The build version number.</value>

4473

</member>

4474

4475

4476

Gets or sets the revision version number.

4477

</summary>

4478

<value>The revision version number.</value>

4479

</member>

4480

4481

4482

Gets or sets the version file.

4483

</summary>

4484

<value>The version file.</value>

4485

</member>

4486

4487

4488

Gets or sets the type of the build.

4489

</summary>

4490

<value>The type of the build.</value>

4491

4492

Possible values include Automatic, Increment, NonIncrement, or Date.

4493

</remarks>

4494

</member>

4495

4496

4497

Gets or sets the type of the revision.

4498

</summary>

4499

<value>The type of the revision.</value>

4500

4501

Possible values include Automatic, Increment, NonIncrement.

4502

</remarks>

4503

</member>

4504

4505

4506

Downloads a resource with the specified URI to a local file.

4507

</summary>

4508

<example>Download the Microsoft.com home page.

4509

<code><![CDATA[

4510

<WebDownload FileUri="http://www.microsoft.com/default.aspx"

4511

FileName="microsoft.html" />

4512

]]></code>

4513

</example>

4514

</member>

4515

4516

4517

Initializes a new instance of the <see cref="T:WebDownload"/> class.

4518

</summary>

4519

</member>

4520

4521

4522

When overridden in a derived class, executes the task.

4523

</summary>

4524

4525

true if the task successfully executed; otherwise, false.

4526

</returns>

4527

</member>

4528

4529

4530

Gets or sets the name of the local file that is to receive the data.

4531

</summary>

4532

4533

</member>

4534

4535

4536

Gets or sets the URI from which to download data.

4537

</summary>

4538

4539

</member>

4540

4541

4542

Reads a value from a XML document using a XPath.

4543

</summary>

4544

<example>Read all targest from a build project.

4545

<code><![CDATA[

4546

<XmlRead Prefix="n"

4547

Namespace="http://schemas.microsoft.com/developer/msbuild/2003"

4548

XPath="/n:Project/n:Target/@Name"

4549

XmlFileName="Subversion.proj">

4550

4551

</XmlRead>

4552

4553

]]></code>

4554

</example>

4555

4556

If the XPath returns multiple nodes, the Value will

4557

be a semicolon delimited list of the nodes text.

4558

</remarks>

4559

</member>

4560

4561

4562

Initializes a new instance of the <see cref="T:XmlRead"/> class.

4563

</summary>

4564

</member>

4565

4566

4567

When overridden in a derived class, executes the task.

4568

</summary>

4569

4570

true if the task successfully executed; otherwise, false.

4571

</returns>

4572

</member>

4573

4574

4575

Gets or sets the name of the XML file.

4576

</summary>

4577

4578

</member>

4579

4580

4581

Gets or sets the XPath.

4582

</summary>

4583

<value>The XPath.</value>

4584

</member>

4585

4586

4587

Gets the value read from file.

4588

</summary>

4589

<value>The value.</value>

4590

4591

If the XPath returns multiple nodes, the values will be semicolon delimited.

4592

</remarks>

4593

</member>

4594

4595

4596

Gets or sets the default namespace.

4597

</summary>

4598

<value>The namespace.</value>

4599

</member>

4600

4601

4602

Gets or sets the prefix to associate with the namespace being added.

4603

</summary>

4604

<value>The namespace prefix.</value>

4605

</member>

4606

4607

4608

Updates a XML document using a XPath.

4609

</summary>

4610

<example>Update a XML element.

4611

<code><![CDATA[

4612

<XmlUpdate Prefix="n"

4613

Namespace="http://schemas.microsoft.com/developer/msbuild/2003"

4614

XPath="/n:Project/n:PropertyGroup/n:TestUpdate"

4615

XmlFileName="Subversion.proj"

4616

Value="Test from $(MSBuildProjectFile)"/>

4617

]]></code>

4618

</example>

4619

4620

The XML node being updated must exist before using the XmlUpdate task.

4621

</remarks>

4622

</member>

4623

4624

4625

Initializes a new instance of the <see cref="T:XmlUpdate"/> class.

4626

</summary>

4627

</member>

4628

4629

4630

When overridden in a derived class, executes the task.

4631

</summary>

4632

4633

true if the task successfully executed; otherwise, false.

4634

</returns>

4635

</member>

4636

4637

4638

Gets or sets the name of the XML file.

4639

</summary>

4640

4641

</member>

4642

4643

4644

Gets or sets the XPath.

4645

</summary>

4646

<value>The XPath.</value>

4647

</member>

4648

4649

4650

Gets or sets the value to write.

4651

</summary>

4652

<value>The value.</value>

4653

</member>

4654

4655

4656

Gets or sets the default namespace.

4657

</summary>

4658

<value>The namespace.</value>

4659

</member>

4660

4661

4662

Gets or sets the prefix to associate with the namespace being added.

4663

</summary>

4664

<value>The namespace prefix.</value>

4665

</member>

4666

4667

4668

Create a zip file with the files specified.

4669

</summary>

4670

<example>Create a zip file

4671

<code><![CDATA[

4672

4673

4674

</ItemGroup>

4675

4676

<Zip Files="@(ZipFiles)"

4677

ZipFileName="MSBuild.Community.Tasks.zip" />

4678

</Target>

4679

]]></code>

4680

Create a zip file using a working directory.

4681

<code><![CDATA[

4682

4683

4684

</ItemGroup>

4685

4686

<Zip Files="@(RepoFiles)"

4687

WorkingDirectory="D:\svn\repo"

4688

ZipFileName="D:\svn\repo.zip" />

4689

</Target>

4690

]]></code>

4691

</example>

4692

</member>

4693

4694

4695

Initializes a new instance of the <see cref="T:Zip"/> class.

4696

</summary>

4697

</member>

4698

4699

4700

When overridden in a derived class, executes the task.

4701

</summary>

4702

4703

true if the task successfully executed; otherwise, false.

4704

</returns>

4705

</member>

4706

4707

4708

Gets or sets the name of the zip file.

4709

</summary>

4710

4711

</member>

4712

4713

4714

Gets or sets the zip level.

4715

</summary>

4716

<value>The zip level.</value>

4717

<remarks>0 - store only to 9 - means best compression</remarks>

4718

</member>

4719

4720

4721

Gets or sets the files to zip.

4722

</summary>

4723

<value>The files to zip.</value>

4724

</member>

4725

4726

4727

Gets or sets a value indicating whether this <see cref="T:Zip"/> is flatten.

4728

</summary>

4729

<value><c>true</c> if flatten; otherwise, <c>false</c>.</value>

4730

4731

Flattening the zip means that all directories will be removed

4732

and the files will be place at the root of the zip file

4733

</remarks>

4734

</member>

4735

4736

4737

Gets or sets the comment.

4738

</summary>

4739

<value>The comment.</value>

4740

</member>

4741

4742

4743

Gets or sets the working directory for the zip file.

4744

</summary>

4745

<value>The working directory.</value>

4746

4747

The working directory is the base of the zip file.

4748

All files will be made relative from the working directory.

4749

</remarks>

4750

</member>

4751

</members>

4752

</doc>