TfDTECommand Class

Article
2013-11-19

Encapsulate a single TfDTE command All TfDTE command accepts the following options: /output:outputFile Specifies an output file. If the command has output, the output should be written to this file. When the command finishes execution, the file outputFile.ready is created to indicate that it is ready. The TfDTE caller can put a FileSystemWatcher on this outputFile.ready file and asynchronously get a notification when the command has finished. The TfDTE command creates the .ready file if it does not exist and replaces the file if it already exists.

The format of outputFile depends on the command.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.TeamFoundation.TfDTECommand
Microsoft.VisualStudio.TeamFoundation.TfDTEBasicRoutedCommand

Namespace: Microsoft.VisualStudio.TeamFoundation
Assembly: Microsoft.VisualStudio.TeamFoundation (in Microsoft.VisualStudio.TeamFoundation.dll)

Syntax

'Declaration
Public Class TfDTECommand

public class TfDTECommand

public ref class TfDTECommand

type TfDTECommand =  class end

public class TfDTECommand

The TfDTECommand type exposes the following members.

Constructors

	Name	Description
	TfDTECommand(String)
	TfDTECommand(String, String)

Top

Properties

	Name	Description
	Arguments
	HelpTopic	Get/Set the help topic associated with this command. This is used in displaying an error message.
	IsAvailable	Returns true if the command can be executed
	Name
	OptionIDs
	OutputFile	Get the output file from /output option, if it is specified
	OutputReadyFile	Get the output.ready file from /output option, if it is specified
	Title	Get/Set the title associated with this command. This is used in displaying an error message.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ParseArguments(String)	Parse the arguments from a string of concatenated arguments. This is called from the direct VSIP command hooks.
	ParseArguments(array<String[])	Parse the arguments from the list of parameters. This is called from the TfDTE command manager.
	ReportBadOptionCombinationIfPresent	Reports a conflict by throwing an exception if both options are present.
	ReportMissingAssociatedOption	Checks that a second option is specified with the first and throws an ArgumentListException if the required option is missing.
	TfDTEExecute	Execute the command
	TfDTEExecuteWithReadyFile	Execute the command and create the output.ready file when the work has finished. DTE command are async. The output.ready file hints the caller that the command has finished execution.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VSIPExec	Helper VSIP exec for used with direct VSIP command hook up.
	VSIPQueryStatus	Helper VSIP query status for used with direct VSIP command hook up.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via