PowerBuild.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PowerBuild</name> </assembly> <members> <member name="T:Microsoft.Build.CommandLine.InitializationException"> <summary> This exception is used to flag failures in application initialization, either due to invalid parameters on the command line, or because the application was invoked in an invalid context. </summary> <remarks> Unlike the CommandLineSwitchException, this exception is NOT thrown for syntax errors in switches. </remarks> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.#ctor"> <summary> Private default constructor prevents parameterless instantiation. </summary> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.#ctor(System.String)"> <summary> This constructor initializes the exception message. </summary> <param name="message"></param> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.#ctor(System.String,System.String)"> <summary> This constructor initializes the exception message and saves the switch that caused the initialization failure. </summary> <param name="message"></param> <param name="invalidSwitch">Can be null.</param> </member> <member name="P:Microsoft.Build.CommandLine.InitializationException.Message"> <summary> Gets the error message and the invalid switch, or only the error message if no invalid switch is set. </summary> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.VerifyThrow(System.Boolean,System.String)"> <summary> Throws the exception if the specified condition is not met. </summary> <param name="condition"></param> <param name="messageResourceName"></param> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.VerifyThrow(System.Boolean,System.String,System.String)"> <summary> Throws the exception if the specified condition is not met. </summary> <param name="condition"></param> <param name="messageResourceName"></param> <param name="invalidSwitch"></param> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.Throw(System.String,System.String,System.Exception,System.Boolean)"> <summary> Throws the exception using the given exception context. </summary> <param name="messageResourceName"></param> <param name="invalidSwitch"></param> <param name="e"></param> <param name="showStackTrace"></param> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.VerifyThrow(System.Boolean,System.String,System.String,System.Object[])"> <summary> Throws the exception if the specified condition is not met. </summary> </member> <member name="M:Microsoft.Build.CommandLine.InitializationException.Throw(System.String,System.String)"> <summary> Throws the exception using the given exception context. </summary> <param name="message"></param> <param name="invalidSwitch"></param> </member> <member name="T:Microsoft.Build.CommandLine.MSBuildApp"> <summary> This class implements the MSBuild.exe command-line application. It processes command-line arguments and invokes the build engine. </summary> </member> <member name="M:Microsoft.Build.CommandLine.MSBuildApp.ValidateExtensions(System.String[])"> <summary> This method takes in a list of file name extensions to ignore. It will then validate the extensions to make sure they start with a period, have atleast one character after the period and do not contain any invalid path chars or wild cards </summary> <param name="projectsExtensionsToIgnore"></param> <returns></returns> </member> <member name="M:Microsoft.Build.CommandLine.MSBuildApp.RemoveFilesWithExtensionsToIgnore(System.String[],System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Removes filenames from the given list whose extensions are on the list of extensions to ignore </summary> <param name="potentialProjectOrSolutionFiles">A list of project or solution file names</param> <param name="extensionsToIgnoreDictionary">A list of extensions to ignore</param> <returns>Array of project or solution files names which do not have an extension to be ignored </returns> </member> <member name="F:Microsoft.Build.CommandLine.MSBuildApp.s_wildcards"> <summary> This is a set of wildcard chars which can cause a file extension to be invalid </summary> </member> <member name="T:Microsoft.Build.Shared.ErrorUtilities"> <summary> This class contains methods that are useful for error checking and validation. </summary> </member> <member name="F:Microsoft.Build.Shared.ErrorUtilities.s_throwExceptions"> <summary> Emergency escape hatch. If a customer hits a bug in the shipped product causing an internal exception, and fortuitously it happens that ignoring the VerifyThrow allows execution to continue in a reasonable way, then we can give them this undocumented environment variable as an immediate workaround. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowInternalError(System.String,System.Object[])"> <summary> Throws InternalErrorException. This is only for situations that would mean that there is a bug in MSBuild itself. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowInternalError(System.String,System.Exception,System.Object[])"> <summary> Throws InternalErrorException. This is only for situations that would mean that there is a bug in MSBuild itself. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowInternalErrorUnreachable"> <summary> Throws InternalErrorException. Indicates the code path followed should not have been possible. This is only for situations that would mean that there is a bug in MSBuild itself. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowIfTypeDoesNotImplementToString(System.Object)"> <summary> Throws InternalErrorException. Indicates the code path followed should not have been possible. This is only for situations that would mean that there is a bug in MSBuild itself. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInternalNull(System.Object,System.String)"> <summary> Helper to throw an InternalErrorException when the specified parameter is null. This should be used ONLY if this would indicate a bug in MSBuild rather than anything caused by user action. </summary> <param name="parameter">The value of the argument.</param> <param name="parameterName">Parameter that should not be null</param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInternalLockHeld(System.Object)"> <summary> Helper to throw an InternalErrorException when a lock on the specified object is not already held. This should be used ONLY if this would indicate a bug in MSBuild rather than anything caused by user action. </summary> <param name="locker">The object that should already have been used as a lock.</param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInternalLength(System.String,System.String)"> <summary> Helper to throw an InternalErrorException when the specified parameter is null or zero length. This should be used ONLY if this would indicate a bug in MSBuild rather than anything caused by user action. </summary> <param name="parameterValue">The value of the argument.</param> <param name="parameterName">Parameter that should not be null or zero length</param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInternalRooted(System.String)"> <summary> Helper to throw an InternalErrorException when the specified parameter is not a rooted path. This should be used ONLY if this would indicate a bug in MSBuild rather than anything caused by user action. </summary> <param name="value">Parameter that should be a rooted path</param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrow(System.Boolean,System.String)"> <summary> This method should be used in places where one would normally put an "assert". It should be used to validate that our assumptions are true, where false would indicate that there must be a bug in our code somewhere. This should not be used to throw errors based on bad user input or anything that the user did wrong. </summary> <param name="condition"></param> <param name="unformattedMessage"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrow(System.Boolean,System.String,System.Object)"> <summary> Overload for one string format argument. </summary> <param name="condition"></param> <param name="unformattedMessage"></param> <param name="arg0"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrow(System.Boolean,System.String,System.Object,System.Object)"> <summary> Overload for two string format arguments. </summary> <param name="condition"></param> <param name="unformattedMessage"></param> <param name="arg0"></param> <param name="arg1"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrow(System.Boolean,System.String,System.Object,System.Object,System.Object)"> <summary> Overload for three string format arguments. </summary> <param name="condition"></param> <param name="unformattedMessage"></param> <param name="arg0"></param> <param name="arg1"></param> <param name="arg2"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrow(System.Boolean,System.String,System.Object,System.Object,System.Object,System.Object)"> <summary> Overload for four string format arguments. </summary> <param name="condition"></param> <param name="unformattedMessage"></param> <param name="arg0"></param> <param name="arg1"></param> <param name="arg2"></param> <param name="arg3"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowInvalidOperation(System.String,System.Object[])"> <summary> Throws an InvalidOperationException with the specified resource string </summary> <param name="resourceName">Resource to use in the exception</param> <param name="args">Formatting args.</param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInvalidOperation(System.Boolean,System.String)"> <summary> Throws an InvalidOperationException if the given condition is false. </summary> <param name="condition"></param> <param name="resourceName"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInvalidOperation(System.Boolean,System.String,System.Object)"> <summary> Overload for one string format argument. </summary> <param name="condition"></param> <param name="resourceName"></param> <param name="arg0"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInvalidOperation(System.Boolean,System.String,System.Object,System.Object)"> <summary> Overload for two string format arguments. </summary> <param name="condition"></param> <param name="resourceName"></param> <param name="arg0"></param> <param name="arg1"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInvalidOperation(System.Boolean,System.String,System.Object,System.Object,System.Object)"> <summary> Overload for three string format arguments. </summary> <param name="condition"></param> <param name="resourceName"></param> <param name="arg0"></param> <param name="arg1"></param> <param name="arg2"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowInvalidOperation(System.Boolean,System.String,System.Object,System.Object,System.Object,System.Object)"> <summary> Overload for four string format arguments. </summary> <param name="condition"></param> <param name="resourceName"></param> <param name="arg0"></param> <param name="arg1"></param> <param name="arg2"></param> <param name="arg3"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowArgument(System.String,System.Object[])"> <summary> Throws an ArgumentException that can include an inner exception. PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for the array of arguments -- do not call this method repeatedly in performance-critical scenarios </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowArgument(System.Exception,System.String,System.Object[])"> <summary> Throws an ArgumentException that can include an inner exception. PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for the array of arguments -- do not call this method repeatedly in performance-critical scenarios </summary> <remarks> This method is thread-safe. </remarks> <param name="innerException">Can be null.</param> <param name="resourceName"></param> <param name="args"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.String)"> <summary> Throws an ArgumentException if the given condition is false. </summary> <remarks>This method is thread-safe.</remarks> <param name="condition"></param> <param name="resourceName"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.String,System.Object)"> <summary> Overload for one string format argument. </summary> <remarks>This method is thread-safe.</remarks> <param name="condition"></param> <param name="resourceName"></param> <param name="arg0"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.String,System.Object,System.Object)"> <summary> Overload for two string format arguments. </summary> <remarks>This method is thread-safe.</remarks> <param name="condition"></param> <param name="resourceName"></param> <param name="arg0"></param> <param name="arg1"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.String,System.Object,System.Object,System.Object)"> <summary> Overload for three string format arguments. </summary> <remarks>This method is thread-safe.</remarks> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.String,System.Object,System.Object,System.Object,System.Object)"> <summary> Overload for four string format arguments. </summary> <remarks>This method is thread-safe.</remarks> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.Exception,System.String)"> <summary> Throws an ArgumentException that includes an inner exception, if the given condition is false. </summary> <remarks>This method is thread-safe.</remarks> <param name="condition"></param> <param name="innerException">Can be null.</param> <param name="resourceName"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.Exception,System.String,System.Object)"> <summary> Overload for one string format argument. </summary> <remarks>This method is thread-safe.</remarks> <param name="condition"></param> <param name="innerException"></param> <param name="resourceName"></param> <param name="arg0"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.Exception,System.String,System.Object,System.Object)"> <summary> Overload for two string format arguments. </summary> <remarks>This method is thread-safe.</remarks> <param name="condition"></param> <param name="innerException"></param> <param name="resourceName"></param> <param name="arg0"></param> <param name="arg1"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.Exception,System.String,System.Object,System.Object,System.Object)"> <summary> Overload for three string format arguments. </summary> <remarks>This method is thread-safe.</remarks> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgument(System.Boolean,System.Exception,System.String,System.Object,System.Object,System.Object,System.Object)"> <summary> Overload for four string format arguments. </summary> <remarks>This method is thread-safe.</remarks> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.ThrowArgumentOutOfRange(System.String)"> <summary> Throws an argument out of range exception. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgumentOutOfRange(System.Boolean,System.String)"> <summary> Throws an ArgumentOutOfRangeException using the given parameter name if the condition is false. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgumentLength(System.String,System.String)"> <summary> Throws an ArgumentNullException if the given string parameter is null and ArgumentException if it has zero length. </summary> <param name="parameter"></param> <param name="parameterName"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgumentLengthIfNotNull(System.String,System.String)"> <summary> Throws an ArgumentException if the string has zero length, unless it is null, in which case no exception is thrown. </summary> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgumentNull(System.Object,System.String)"> <summary> Throws an ArgumentNullException if the given parameter is null. </summary> <remarks>This method is thread-safe.</remarks> <param name="parameter"></param> <param name="parameterName"></param> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgumentNull(System.Object,System.String,System.String)"> <summary> Throws an ArgumentNullException if the given parameter is null. </summary> <remarks>This method is thread-safe.</remarks> </member> <member name="M:Microsoft.Build.Shared.ErrorUtilities.VerifyThrowArgumentArraysSameLength(System.Array,System.Array,System.String,System.String)"> <summary> Verifies the given arrays are not null and have the same length </summary> <param name="parameter1"></param> <param name="parameter2"></param> <param name="parameter1Name"></param> <param name="parameter2Name"></param> </member> <member name="T:Microsoft.Build.Shared.DirectoryGetFiles"> <summary> delegate for System.IO.Directory.GetFiles, used for testing </summary> <param name="path">Directory path to start search for files in</param> <param name="searchPattern">pattern of files to match</param> <returns>string array of files which match search pattern</returns> </member> <member name="T:Microsoft.Build.Shared.GetDirectories"> <summary> delegate for Directory.GetDirectories. </summary> <param name="path">The path to get directories for.</param> <param name="pattern">The pattern to search for.</param> <returns>An array of directories.</returns> </member> <member name="T:Microsoft.Build.Shared.DirectoryExists"> <summary> Delegate for System.IO.Directory.Exists </summary> <param name="path">Directory path to check if it exists</param> <returns>true if directory exists</returns> </member> <member name="T:Microsoft.Build.Shared.FileExists"> <summary> File exists delegate </summary> <param name="path">The path to check for existence.</param> <returns>'true' if the file exists.</returns> </member> <member name="T:Microsoft.Build.Shared.FileCopy"> <summary> File.Copy delegate </summary> <param name="source"></param> <param name="destination"></param> </member> <member name="T:Microsoft.Build.Shared.FileDelete"> <summary> File.Delete delegate </summary> <param name="path"></param> </member> <member name="T:Microsoft.Build.Shared.FileCreate"> <summary> File create delegate </summary> <param name="path">The path to create.</param> </member> <member name="T:Microsoft.Build.Shared.InternalErrorException"> <summary> This exception is to be thrown whenever an assumption we have made in the code turns out to be false. Thus, if this exception ever gets thrown, it is because of a bug in our own code, not because of something the user or project author did wrong. !~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~ WARNING: When this file is shared into multiple assemblies each assembly will view this as a different type. Don't throw this exception from one assembly and catch it in another. !~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~!~ </summary> </member> <member name="M:Microsoft.Build.Shared.InternalErrorException.#ctor"> <summary> Default constructor. SHOULD ONLY BE CALLED BY DESERIALIZER. SUPPLY A MESSAGE INSTEAD. </summary> </member> <member name="M:Microsoft.Build.Shared.InternalErrorException.#ctor(System.String)"> <summary> Creates an instance of this exception using the given message. </summary> </member> <member name="M:Microsoft.Build.Shared.InternalErrorException.#ctor(System.String,System.Exception)"> <summary> Creates an instance of this exception using the given message and inner exception. Adds the inner exception's details to the exception message because most bug reporters don't bother to provide the inner exception details which is typically what we care about. </summary> </member> <member name="M:Microsoft.Build.Shared.InternalErrorException.ConsiderDebuggerLaunch(System.String,System.Exception)"> <summary> A fatal internal error due to a bug has occurred. Give the dev a chance to debug it, if possible. Will in all cases launch the debugger, if the environment variable "MSBUILDLAUNCHDEBUGGER" is set. In DEBUG build, will always launch the debugger, unless we are in razzle (_NTROOT is set) or in NUnit, or MSBUILDDONOTLAUNCHDEBUGGER is set (that could be useful in suite runs). We don't launch in retail or LKG so builds don't jam; they get a callstack, and continue or send a mail, etc. We don't launch in NUnit as tests often intentionally cause InternalErrorExceptions. Because we only call this method from this class, just before throwing an InternalErrorException, there is no danger that this suppression will cause a bug to only manifest itself outside NUnit (which would be most unfortunate!). Do not make this non-private. Unfortunately NUnit can't handle unhandled exceptions like InternalErrorException on anything other than the main test thread. However, there's still a callstack displayed before it quits. If it is going to launch the debugger, it first does a Debug.Fail to give information about what needs to be debugged -- the exception hasn't been thrown yet. This automatically displays the current callstack. </summary> </member> <member name="T:Microsoft.Build.Shared.ResourceUtilities"> <summary> This class contains utility methods for dealing with resources. </summary> </member> <member name="M:Microsoft.Build.Shared.ResourceUtilities.ExtractMessageCode(System.Boolean,System.String,System.String@)"> <summary> Extracts the message code (if any) prefixed to the given string. <![CDATA[ MSBuild codes match "^\s*(?<CODE>MSB\d\d\d\d):\s*(?<MESSAGE>.*)$" Arbitrary codes match "^\s*(?<CODE>[A-Za-z]+\d+):\s*(?<MESSAGE>.*)$" ]]> Thread safe. </summary> <param name="msbuildCodeOnly">Whether to match only MSBuild error codes, or any error code.</param> <param name="message">The string to parse.</param> <param name="code">[out] The message code, or null if there was no code.</param> <returns>The string without its message code prefix, if any.</returns> </member> <member name="M:Microsoft.Build.Shared.ResourceUtilities.GetHelpKeyword(System.String)"> <summary> Retrieves the MSBuild F1-help keyword for the given resource string. Help keywords are used to index help topics in host IDEs. </summary> <param name="resourceName">Resource string to get the MSBuild F1-keyword for.</param> <returns>The MSBuild F1-help keyword string.</returns> </member> <member name="M:Microsoft.Build.Shared.ResourceUtilities.GetResourceString(System.String)"> <summary> Retrieves the contents of the named resource string. </summary> <param name="resourceName">Resource string name.</param> <returns>Resource string contents.</returns> </member> <member name="M:Microsoft.Build.Shared.ResourceUtilities.FormatResourceString(System.String@,System.String@,System.String,System.Object[])"> <summary> Loads the specified string resource and formats it with the arguments passed in. If the string resource has an MSBuild message code and help keyword associated with it, they too are returned. PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for the array of arguments -- do not call this method repeatedly in performance-critical scenarios </summary> <remarks>This method is thread-safe.</remarks> <param name="code">[out] The MSBuild message code, or null.</param> <param name="helpKeyword">[out] The MSBuild F1-help keyword for the host IDE, or null.</param> <param name="resourceName">Resource string to load.</param> <param name="args">Optional arguments for formatting the resource string.</param> <returns>The formatted resource string.</returns> </member> <member name="M:Microsoft.Build.Shared.ResourceUtilities.FormatResourceString(System.String,System.Object[])"> <summary> Looks up a string in the resources, and formats it with the arguments passed in. If the string resource has an MSBuild message code and help keyword associated with it, they are discarded. PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for the array of arguments -- do not call this method repeatedly in performance-critical scenarios </summary> <remarks>This method is thread-safe.</remarks> <param name="resourceName">Resource string to load.</param> <param name="args">Optional arguments for formatting the resource string.</param> <returns>The formatted resource string.</returns> </member> <member name="M:Microsoft.Build.Shared.ResourceUtilities.FormatString(System.String,System.Object[])"> <summary> Formats the given string using the variable arguments passed in. PERF WARNING: calling a method that takes a variable number of arguments is expensive, because memory is allocated for the array of arguments -- do not call this method repeatedly in performance-critical scenarios Thread safe. </summary> <param name="unformatted">The string to format.</param> <param name="args">Optional arguments for formatting the given string.</param> <returns>The formatted string.</returns> </member> <member name="M:Microsoft.Build.Shared.ResourceUtilities.VerifyResourceStringExists(System.String)"> <summary> Verifies that a particular resource string actually exists in the string table. This will only be called in debug builds. It helps catch situations where a dev calls VerifyThrowXXX with a new resource string, but forgets to add the resource string to the string table, or misspells it! </summary> <remarks>This method is thread-safe.</remarks> <param name="resourceName">Resource string to check.</param> </member> <member name="T:PowerBuild.Logging.InvokeDomainLogger"> <summary> Wrapper for loggers created in Invoke-MSBuild application domain. </summary> </member> <member name="T:PowerBuild.InvokeMSBuild"> <summary> Use MSBuild to build a project. </summary> <para type="synopsis"> Use MSBuild to build a project. </para> <para type="description"> Builds the specified targets in the project file. If a project file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in "proj" and uses that file. </para> <example> <code>Invoke-MSBuild -Project Project.sln -Target Build -Property @{Configuration="Release"} -Verbosity Minimal</code> </example> </member> <member name="P:PowerBuild.InvokeMSBuild.DetailedSummary"> <summary> Gets or sets detailed summary parameter. </summary> <para type="description"> Shows detailed information at the end of the build about the configurations built and how they were scheduled to nodes. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.IgnoreProjectExtensions"> <summary> Get or sets project extensions to ignore. </summary> <para type="description"> List of extensions to ignore when determining which project file to build. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.Logger"> <summary> Get or sets logger collection. </summary> <para type="description"> Use this loggers to log events from MSBuild. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.MaxCpuCount"> <summary> Gets or sets number of concurrent processes to build with. </summary> <para type="description"> Specifies the maximum number of concurrent processes to build with. If the switch is not used, the default value used is 1. If the switch is used with a $null, value MSBuild will use up to the number of processors on the computer. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.NodeReuse"> <summary> Gets or sets node reuse. </summary> <para type="description"> Enables or Disables the reuse of MSBuild nodes. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.Project"> <summary> Gets or sets project to build. </summary> <para type="description"> Project to build. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.Property"> <summary> Gets or sets properties. </summary> <para type="description"> Set or override these project-level properties. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.Target"> <summary> Gets or sets targets to build. </summary> <para type="description"> Build these targets in the project. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.ToolsVersion"> <summary> Gets or sets tools version. </summary> <para type="description"> The version of the MSBuild Toolset (tasks, targets, etc.) to use during build.This version will override the versions specified by individual projects. </para> </member> <member name="P:PowerBuild.InvokeMSBuild.Verbosity"> <summary> Gets or sets logging verbosity. </summary> <para type="description"> Display this amount of information in the event log. </para> </member> <member name="P:PowerBuild.BuildResult.CircularDependency"> <summary>Gets a flag indicating whether a circular dependency was detected.</summary> <returns>Returns true if a circular dependency was detected; false otherwise.</returns> </member> <member name="P:PowerBuild.BuildResult.ConfigurationId"> <summary>Gets the configuration ID for this build result set.</summary> <returns>Returns the configuration ID for this build result set.</returns> </member> <member name="P:PowerBuild.BuildResult.Exception"> <summary>Gets the exception generated for this build result set. </summary> <returns>Returns the exception generated for this build result set. Returns false if no exception occurred.</returns> </member> <member name="P:PowerBuild.BuildResult.GlobalRequestId"> <summary>Gets the build request id for this build result set.</summary> <returns>Returns the build request id for this build result set.</returns> </member> <member name="P:PowerBuild.BuildResult.Items"> <summary>Gets an enumerator over all items in this build result set.</summary> <returns>Returns an enumerator over all items in this build result set.</returns> </member> <member name="P:PowerBuild.BuildResult.NodeRequestId"> <summary>Gets the build request ID of the originating node.</summary> <returns>Returns the build request ID of the originating node.</returns> </member> <member name="P:PowerBuild.BuildResult.OverallResult"> <summary>Gets the overall result for this build.</summary> <returns>Returns the overall result for this build.</returns> </member> <member name="P:PowerBuild.BuildResult.ParentGlobalRequestId"> <summary>Gets the global build request ID which issued the request leading to this build result set.</summary> <returns>Returns the global build request ID which issued the request leading to this build result set.</returns> </member> <member name="P:PowerBuild.BuildResult.ResultsByTarget"> <summary>Gets an enumerator over all target results in this build result set.</summary> <returns>Returns an enumerator over all target results in this build result set.</returns> </member> <member name="P:PowerBuild.BuildResult.SubmissionId"> <summary>Gets the build submission which this build result set is associated with.</summary> <returns>Returns the build submission which this build result set is associated with.</returns> </member> <member name="P:PowerBuild.BuildResult.Targets"> <summary>Gets an enumerator over all targets in this build result set.</summary> <returns>Returns an enumerator over all targets in this build result set.</returns> </member> <member name="P:PowerBuild.BuildResult.Item(System.String)"> <summary>Gets an indexer which can be used to get the build result for the given target.</summary> <returns>The build result for the indexed target.</returns> <param name="target">The indexed target.</param> </member> <member name="M:PowerBuild.BuildResult.HasResultsForTarget(System.String)"> <summary>Determines if there are any results for the given target.</summary> <returns>Returns true if results exist; false otherwise.</returns> <param name="target">The target whose results are retrieved.</param> </member> <member name="T:PowerBuild.NewConsoleLogger"> <para type="synopsis"> Create new console logger. </para> <para type="description"> Create new configured console logger. Parameters are equivalent of msbuild.exe's /consoleloggerparameters:<parameters> switch. </para> <example> <code>New-ConsoleLogger -Verbosity Minimal -PerformanceSummary</code> </example> </member> <member name="P:PowerBuild.NewConsoleLogger.DisableConsoleColor"> <para type="description"> Use the default console colors for all logging messages. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.DisableMPLogging"> <para type="description"> Disable the multiprocessor logging style of output when running in non - multiprocessor mode. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.EnableMPLogging"> <para type="description"> Enable the multiprocessor logging style even when running in non - multiprocessor mode.This logging style is on by default. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.ErrorsOnly"> <para type="description"> Show only errors. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.ForceConsoleColor"> <para type="description"> Use ANSI console colors even if console does not support it. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.ForceNoAlign"> <para type="description"> Does not align the text to the size of the console buffer. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.NoItemAndPropertyList"> <para type="description"> Don't show list of items and properties at the start of each project build. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.NoSummary"> <para type="description"> Don't show error and warning summary at the end. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.PerformanceSummary"> <para type="description"> Show time spent in tasks, targets and projects. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.ShowCommandLine"> <para type="description"> Show TaskCommandLineEvent messages. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.ShowEventId"> <para type="description"> Show eventId for started events, finished events, and messages. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.ShowTimestamp"> <para type="description"> Display the Timestamp as a prefix to any message. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.Summary"> <para type="description"> Show error and warning summary at the end. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.Verbosity"> <para type="description"> Overrides the Verbosity setting for this logger. Default verbosity is Normal. </para> </member> <member name="P:PowerBuild.NewConsoleLogger.WarningsOnly"> <para type="description"> Show only warnings. </para> </member> <member name="T:PowerBuild.NewFileLogger"> <para type="synopsis"> Create new file logger. </para> <para type="description"> Create new configured file logger. Parameters are equivalent of msbuild.exe's /fileloggerparameters:<parameters> switch. </para> <example> <code>New-FileLogger -Verbosity Normal -PerformanceSummary</code> </example> </member> <member name="P:PowerBuild.NewFileLogger.Append"> <summary> </summary> <para type="description"> Determines if the build log will be appended to or overwrite the log file.Setting the switch appends the build log to the log file; Not setting the switch overwrites the contents of an existing log file. The default is not to append to the log file. </para> </member> <member name="P:PowerBuild.NewFileLogger.DisableConsoleColor"> <para type="description"> Use the default console colors for all logging messages. </para> </member> <member name="P:PowerBuild.NewFileLogger.DisableMPLogging"> <para type="description"> Disable the multiprocessor logging style of output when running in non - multiprocessor mode. </para> </member> <member name="P:PowerBuild.NewFileLogger.EnableMPLogging"> <para type="description"> Enable the multiprocessor logging style even when running in non - multiprocessor mode.This logging style is on by default. </para> </member> <member name="P:PowerBuild.NewFileLogger.Encoding"> <para type="description"> Specifies the encoding for the file, for example, UTF-8, Unicode, or ASCII </para> </member> <member name="P:PowerBuild.NewFileLogger.ErrorsOnly"> <para type="description"> Show only errors. </para> </member> <member name="P:PowerBuild.NewFileLogger.ForceConsoleColor"> <para type="description"> Use ANSI console colors even if console does not support it. </para> </member> <member name="P:PowerBuild.NewFileLogger.ForceNoAlign"> <para type="description"> Does not align the text to the size of the console buffer. </para> </member> <member name="P:PowerBuild.NewFileLogger.LogFile"> <para type="description"> Path to the log file into which the build log will be written. </para> </member> <member name="P:PowerBuild.NewFileLogger.NoItemAndPropertyList"> <para type="description"> Don't show list of items and properties at the start of each project build. </para> </member> <member name="P:PowerBuild.NewFileLogger.NoSummary"> <para type="description"> Don't show error and warning summary at the end. </para> </member> <member name="P:PowerBuild.NewFileLogger.PerformanceSummary"> <para type="description"> Show time spent in tasks, targets and projects. </para> </member> <member name="P:PowerBuild.NewFileLogger.ShowCommandLine"> <para type="description"> Show TaskCommandLineEvent messages. </para> </member> <member name="P:PowerBuild.NewFileLogger.ShowEventId"> <para type="description"> Show eventId for started events, finished events, and messages. </para> </member> <member name="P:PowerBuild.NewFileLogger.ShowTimestamp"> <para type="description"> Display the Timestamp as a prefix to any message. </para> </member> <member name="P:PowerBuild.NewFileLogger.Summary"> <para type="description"> Show error and warning summary at the end. </para> </member> <member name="P:PowerBuild.NewFileLogger.Verbosity"> <para type="description"> Overrides the Verbosity setting for this logger. Default verbosity is Detailed. </para> </member> <member name="P:PowerBuild.NewFileLogger.WarningsOnly"> <para type="description"> Show only warnings. </para> </member> <member name="M:PowerBuild.NewFileLogger.ProcessRecord"> <summary> Processes the record. </summary> </member> <member name="T:PowerBuild.NewLogger"> <para type="synopsis"> Create new logger. </para> <para type="description"> Create new logger using class name and assembly. Parameters are equivalent of msbuild.exe's /l:<logger> switch. </para> <example> <code>New-Logger -ClassName FileLogger -Assembly Microsoft.Build.Engine -Parameters "LogFile=MyLog.log;Append;Verbosity=diagnostic;Encoding=UTF-8"</code> </example> </member> <member name="P:PowerBuild.NewLogger.Assembly"> <para type="description"> Logger assembly name or file path. </para> </member> <member name="P:PowerBuild.NewLogger.ClassName"> <para type="description"> Logger class name. Can contain partial or full namespace. </para> </member> <member name="P:PowerBuild.NewLogger.Parameters"> <para type="description"> Parameters passed to logger. </para> </member> <member name="P:PowerBuild.NewLogger.Verbosity"> <para type="description"> Overrides the Verbosity setting for this logger. Default verbosity is Normal. </para> </member> <member name="P:PowerBuild.TargetResult.Exception"> <summary>Gets the exception generated when the target was built.</summary> <returns>Returns the exception generated when the target was built. Return null if no exception occurred.</returns> </member> <member name="P:PowerBuild.TargetResult.Items"> <summary>Gets the set of build items output by the target. </summary> <returns>Returns the set of build items output by the target. </returns> </member> <member name="P:PowerBuild.TargetResult.ResultCode"> <summary>Gets the result code returned when the target was built.</summary> <returns>Returns the result code returned when the target was built.</returns> </member> </members> </doc> |