| Build2xHelpFile Class |
Namespace: SandcastleBuilder.Utils.MSBuild
The Build2xHelpFile type exposes the following members.
| Name | Description | |
|---|---|---|
| Build2xHelpFile | Initializes a new instance of the Build2xHelpFile class |
| Name | Description | |
|---|---|---|
| CallHostObjectToExecute | Calls the host object to perform the work of the task. (Inherited from ToolTask.) | |
| Cancel | Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask.) | |
| DeleteTempFile | Deletes the specified temporary file. (Inherited from ToolTask.) | |
| Equals | (Inherited from Object.) | |
| Execute |
This is overridden to set the working folder before executing the task and to dump the compiler log
file after the build.
(Overrides ToolTaskExecute.) | |
| ExecuteTool | Creates a temporoary response (.rsp) file and runs the executable file. (Inherited from ToolTask.) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
| GenerateCommandLineCommands |
Generate the command line parameters
(Overrides ToolTaskGenerateCommandLineCommands.) | |
| GenerateFullPathToTool |
This returns the full path to the tool
(Overrides ToolTaskGenerateFullPathToTool.) | |
| GenerateResponseFileCommands | Returns a string value containing the command line arguments to add to the response (.rsp) file before running the executable file. (Inherited from ToolTask.) | |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetProcessStartInfo | Initializes the information required to spawn the process executing the tool. (Inherited from ToolTask.) | |
| GetResponseFileSwitch | Returns the command line switch used by the executable file to specifiy a response (.rsp) file. (Inherited from ToolTask.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| GetWorkingDirectory | Returns the directory in which to run the executable file. (Inherited from ToolTask.) | |
| HandleTaskExecutionErrors |
This is overridden to invert the result of the HXCOMP exit code
(Overrides ToolTaskHandleTaskExecutionErrors.) | |
| InitializeHostObject | Initializes the host object of the task. (Inherited from ToolTask.) | |
| LogEventsFromTextOutput | Parses a single line of text to identify any errors or warnings in canonical format. (Inherited from ToolTask.) | |
| LogPathToTool | Logs the tool name and path to all registered loggers. (Inherited from ToolTask.) | |
| LogToolCommand | Logs the starting point of the run to all registered loggers. (Inherited from ToolTask.) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| SkipTaskExecution | Indicates whether task execution should be skipped. (Inherited from ToolTask.) | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) | |
| ValidateParameters |
Validate the parameters
(Overrides ToolTaskValidateParameters.) |
| Name | Description | |
|---|---|---|
| BuildEngine | Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.) | |
| BuildEngine2 | Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.) | |
| BuildEngine3 | Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.) | |
| EchoOff | Indicates that command line echoing is turned off. (Inherited from ToolTask.) | |
| EnvironmentOverride | Obsolete. Gets a set of environment variable name-value pairs. Designed to be overridden in a custom task class (derived from ToolTask) to return a set of new or altered environment variables to create the execution context of the associated tool. (Inherited from ToolTask.) | |
| EnvironmentVariables | Array of equals-separated pairs of environment variables that should be passed to the spawned executable, in addition to (or selectively overriding) the regular environment block. (Inherited from ToolTask.) | |
| ExitCode | Gets the returned exit code of the executable file. (Inherited from ToolTask.) | |
| HasLoggedErrors | Whether this ToolTask has logged any errors (Inherited from ToolTask.) | |
| HelpCompilerFolder |
This is used to pass in the path to the help compiler
| |
| HelpKeywordPrefix | Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.) | |
| HostObject | Gets or sets the host object associated with the task. (Inherited from Task.) | |
| HtmlHelpName |
This is used to pass in the name of the help file (no path or extension)
| |
| Log | Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.) | |
| LogStandardErrorAsError | Should ALL messages received on the standard error stream be logged as errors. (Inherited from ToolTask.) | |
| ResponseFileEncoding | Gets the Encoding of the response file. (Inherited from ToolTask.) | |
| StandardErrorEncoding | Gets the Encoding of the standard error stream of the task. (Inherited from ToolTask.) | |
| StandardErrorImportance | Task Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask.) | |
| StandardErrorImportanceToUse | Gets the actual importance at which standard error messages will be logged. (Inherited from ToolTask.) | |
| StandardErrorLoggingImportance |
This is overridden to force all standard error info to be logged
(Overrides ToolTaskStandardErrorLoggingImportance.) | |
| StandardOutputEncoding | Gets the Encoding of the standard output stream of the task. (Inherited from ToolTask.) | |
| StandardOutputImportance | Task Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask.) | |
| StandardOutputImportanceToUse | Gets the actual importance at which standard out messages will be logged. (Inherited from ToolTask.) | |
| StandardOutputLoggingImportance |
This is overridden to force all standard output info to be logged
(Overrides ToolTaskStandardOutputLoggingImportance.) | |
| TaskProcessTerminationTimeout | A timeout to wait for a task to terminate before killing it. In milliseconds. (Inherited from ToolTask.) | |
| TaskResources | Gets or sets the culture-specific resources associated with the task. (Inherited from Task.) | |
| Timeout | Gets or sets the amount of time after which the task executable is terminated. (Inherited from ToolTask.) | |
| ToolCanceled | Used to signal when a tool has been cancelled. (Inherited from ToolTask.) | |
| ToolExe | Projects may set this to override a task's ToolName. Tasks may override this to prevent that. (Inherited from ToolTask.) | |
| ToolName |
This read-only property returns the tool name (HXCOMP.EXE)
(Overrides ToolTaskToolName.) | |
| ToolPath | Gets or sets the path of the executable file to run. (Inherited from ToolTask.) | |
| UseCommandProcessor | Gets or sets a switch that specifies whether the tool task will create a batch file for the command-line and execute that using the command-processor, rather than executing the command directly. (Inherited from ToolTask.) | |
| WorkingFolder |
This is used to pass in the working folder where the files are located
| |
| YieldDuringToolExecution | Indicates if the task will yield the node during tool execution. (Inherited from ToolTask.) |