SGen Class

This API supports the product infrastructure and is not intended to be used directly from your code.

Initializes a new instance of the SGen class.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets the collection of parameters used by the derived task class.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the assembly to generate serialization code for.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the path to the assembly to generate serialization code for.

The build engine automatically sets this property to allow tasks to call back into it.

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

Retrieves the IBuildEngine7 version of the build engine interface provided by the host.

Retrieves the IBuildEngine8 version of the build engine interface provided by the host.

Retrieves the IBuildEngine9 version of the build engine interface provided by the host.

ToolTask is not incremental by default. When a derived class overrides SkipTaskExecution, then Question feature can take into effect.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a Boolean value that specifies whether the SGen task places the public key in the assembly (true) or fully signs the assembly (false).

When set to true, it passes /Q to the cmd.exe command line such that the command line does not get echo-ed on stdout

Gets the Path override value.

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.

The return code of the spawned process. If the task logged any errors, but the process had an exit code of 0 (success), this will be set to -1.

This API supports the product infrastructure and is not intended to be used directly from your code.

Whether this ToolTaskExtension has logged any errors

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

The build engine sets this property if the host IDE has associated a host object with this particular task.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a container that holds a key pair.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a key pair or a public key to use to sign an assembly.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

Should ALL messages received on the standard error stream be logged as errors.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or Sets the Compiler Platform used by SGen to generate the output assembly.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the assemblies that are referenced by the types requiring XML serialization.

Overridable property specifying the encoding of the response file, UTF8 by default

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the SDK Tools path.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the generated serialization assembly.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets the name of the generated serialization assembly.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a Boolean value that specifies whether the SGen task should generate a serialization assembly.

Overridable property specifying the encoding of the captured task standard error stream

Task Parameter: Importance with which to log text from the standard error stream.

The actual importance at which standard error messages will be logged.

Importance with which to log text from the standard error stream.

Overridable property specifying the encoding of the captured task standard output stream

Task Parameter: Importance with which to log text from the standard out stream.

The actual importance at which standard out messages will be logged.

Importance with which to log text from in the standard out stream.

A timeout to wait for a task to terminate before killing it. In milliseconds.

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

Project visible property that allows the user to specify an amount of time after which the task executable is terminated.

Used to signal when a tool has been cancelled.

Projects may set this to override a task's ToolName. Tasks may override this to prevent that.

This API supports the product infrastructure and is not intended to be used directly from your code.

The name of the tool to execute.

Project-visible property allows the user to override the path to the executable.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or Sets a list of specific Types to generate serialization code for, SGen will generate serialization code only for those types.

When set to true, 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.

When set to true, the response file will use new lines instead of spaces to separate arguments.

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a Boolean value that specifies whether the SGen task generates serialization code only for the XML Web service proxy types.

Whether or not to use UTF8 encoding for the cmd file and console window. Values: Always, Never, Detect If set to Detect, the current code page will be used unless it cannot represent the Command string. In that case, UTF-8 is used.

When set to true, this task will yield the node when its task is executing.

This API supports the product infrastructure and is not intended to be used directly from your code.

Fills the provided CommandLineBuilderExtension with those switches and other information that can't go into a response file and must go directly onto the command line.

This API supports the product infrastructure and is not intended to be used directly from your code.

Fills the provided CommandLineBuilderExtension with those switches and other information that can go into a response file.

Replace backslashes with OS-specific path separators, except when likely that the backslash is intentional.

We expect the tasks to override this method, if they support host objects. The implementation should call into the host object to perform the real work of the task. For example, for compiler tasks like Csc and Vbc, this method would call Compile() on the host object.

Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.

Delete temporary file. If the delete fails for some reason (e.g. file locked by anti-virus) then the call will not throw an exception. Instead a warning will be logged, but the build will not fail.

This method invokes the tool with the given parameters.

Writes out a temporary response file and shell-executes the tool requested. Enables concurrent logging of the output of the tool.

This API supports the product infrastructure and is not intended to be used directly from your code.

Returns a string with those switches and other information that can't go into a response file and must go directly onto the command line. Called after ValidateParameters and SkipTaskExecution

This API supports the product infrastructure and is not intended to be used directly from your code.

Returns a string with those switches and other information that can't go into a response file and must go directly onto the command line. Called after ValidateParameters and SkipTaskExecution

This API supports the product infrastructure and is not intended to be used directly from your code.

The full path of the tool to execute.

This API supports the product infrastructure and is not intended to be used directly from your code.

Returns the command line switch used by the tool executable to specify the response file Will only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands

This API supports the product infrastructure and is not intended to be used directly from your code.

Get a bool parameter and return a default if its not present in the hash table.

This API supports the product infrastructure and is not intended to be used directly from your code.

Get an int parameter and return a default if its not present in the hash table.

Initializes the information required to spawn the process executing the tool.

Returns the command line switch used by the tool executable to specify the response file. Will only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands

Gets the working directory to use for the process. Should return null if ToolTask should use the current directory.

Allows tool to handle the return code. This method will only be called with non-zero exitCode.

We expect tasks to override this method if they support host objects. The implementation should make sure that the host object is ready to perform the real work of the task.

Calls a method on the TaskLoggingHelper to parse a single line of text to see if there are any errors or warnings in canonical format. This can be overridden by the derived class if necessary.

Logs the tool name and the path from where it is being run.

Logs the actual command line about to be executed (or what the task wants the log to show)

Overridable function called after Start() in ExecuteTool(String, String, String)

Signals when the tool exits. The Process object executing the tool calls this method when the tool exits.

Queues up the output from the stderr stream of the process executing the tool, and signals the availability of the data. The Process object executing the tool calls this method for every line of text that the tool writes to stderr.

Queues up the output from the stdout stream of the process executing the tool, and signals the availability of the data. The Process object executing the tool calls this method for every line of text that the tool writes to stdout.

Overridable method to escape content of the response file

This API supports the product infrastructure and is not intended to be used directly from your code.

Returns true if task execution is not necessary. Executed after ValidateParameters

Returns true if task execution is not necessary. Executed after ValidateParameters

We expect tasks to override this method if they need information about the tool process or its process events during task execution. Implementation should make sure that the task is started in this method. Starts the process during task execution.

This API supports the product infrastructure and is not intended to be used directly from your code.

Validate parameters, log errors and warnings and return true if Execute should proceed.

Implemented in the derived class