System.CodeDom.Compiler.Executor Class

Assembly: System.dll
Namespace: System.CodeDom.Compiler
Summary
Provides command execution functions for invoking compilers. This class cannot be inherited.
C# Syntax:
public sealed class Executor
See also:
System.CodeDom.Compiler Namespace

System.CodeDom.Compiler.Executor Member List:

Public Methods
Equals
(inherited from System.Object)
See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
ExecWait Executes the command using the specified temporary files and waits for the call to return.
ExecWaitWithCapture Overloaded:
ExecWaitWithCapture(string cmd, TempFileCollection tempFiles, ref string outputName, ref string errorName)

Executes the specified command using the specified temporary files and waits for the call to return, storing output and error information from the compiler in the specified strings.
ExecWaitWithCapture Overloaded:
ExecWaitWithCapture(IntPtr userToken, string cmd, TempFileCollection tempFiles, ref string outputName, ref string errorName)

Executes the specified command using the specified user token and temporary files, and waits for the call to return, storing output and error information from the compiler in the specified strings.
ExecWaitWithCapture Overloaded:
ExecWaitWithCapture(string cmd, string currentDir, TempFileCollection tempFiles, ref string outputName, ref string errorName)

Executes the specified command using the specified current directory and temporary files, and waits for the call to return, storing output and error information from the compiler in the specified strings.
ExecWaitWithCapture Overloaded:
ExecWaitWithCapture(IntPtr userToken, string cmd, string currentDir, TempFileCollection tempFiles, ref string outputName, ref string errorName)

Executes the specified command using the specified user token, current directory, and temporary files; then waits for the call to return, storing output and error information from the compiler in the specified strings.
GetHashCode
(inherited from System.Object)
See base class member description: System.Object.GetHashCode

Derived from System.Object, the primary base class for all objects.
GetType
(inherited from System.Object)
See base class member description: System.Object.GetType

Derived from System.Object, the primary base class for all objects.
ToString
(inherited from System.Object)
See base class member description: System.Object.ToString

Derived from System.Object, the primary base class for all objects.
Protected Methods
Finalize
(inherited from System.Object)
See base class member description: System.Object.Finalize

Derived from System.Object, the primary base class for all objects.
MemberwiseClone
(inherited from System.Object)
See base class member description: System.Object.MemberwiseClone

Derived from System.Object, the primary base class for all objects.

Hierarchy:


System.CodeDom.Compiler.Executor Member Details

Method: Equals(
   object obj
)
Inherited
See base class member description: System.Object.Equals
C# Syntax:
public virtual bool Equals(
   object obj
);

For more information on members inherited from System.Object click on the link above.

Return to top


Method: ExecWait(
   string cmd,
   TempFileCollection tempFiles
)
Summary
Executes the command using the specified temporary files and waits for the call to return.
C# Syntax:
public static void ExecWait(
   string cmd,
   TempFileCollection tempFiles
);
Parameters:

cmd

The command to execute.

tempFiles

A TempFileCollection that indicates the temporary files to use.

Return Value:
The return value from the compiler.
See also:
TempFileCollection

Return to top


Overloaded Method: ExecWaitWithCapture(
   string cmd,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
)
Summary
Executes the specified command using the specified temporary files and waits for the call to return, storing output and error information from the compiler in the specified strings.
C# Syntax:
public static int ExecWaitWithCapture(
   string cmd,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
);
Parameters:

cmd

The command to execute.

tempFiles

A TempFileCollection that indicates the temporary files to use.

outputName

A reference to a string that will store the compiler's message output.

errorName

A reference to a string that will store the name of the error or errors encountered.

Return Value:
The return value from the compiler.

Return to top


Overloaded Method: ExecWaitWithCapture(
   IntPtr userToken,
   string cmd,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
)
Summary
Executes the specified command using the specified user token and temporary files, and waits for the call to return, storing output and error information from the compiler in the specified strings.
C# Syntax:
public static int ExecWaitWithCapture(
   IntPtr userToken,
   string cmd,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
);
Parameters:

userToken

The token to start the compiler process with.

cmd

The command to execute.

tempFiles

A TempFileCollection that indicates the temporary files to use.

outputName

A reference to a string that will store the compiler's message output.

errorName

A reference to a string that will store the name of the error or errors encountered.

Return Value:
The return value from the compiler.
Remarks
The userToken parameter accepts a Win32 security access token that indicates the security context for the process to be started in. For more information, consult the Windows CreateProcessAsUser method documentation in the Platform SDK documentation in MSDN.
See also:
TempFileCollection

Return to top


Overloaded Method: ExecWaitWithCapture(
   string cmd,
   string currentDir,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
)
Summary
Executes the specified command using the specified current directory and temporary files, and waits for the call to return, storing output and error information from the compiler in the specified strings.
C# Syntax:
public static int ExecWaitWithCapture(
   string cmd,
   string currentDir,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
);
Parameters:

cmd

The command to execute.

currentDir

The current directory.

tempFiles

A TempFileCollection that indicates the temporary files to use.

outputName

A reference to a string that will store the compiler's message output.

errorName

A reference to a string that will store the name of the error or errors encountered.

Return Value:
The return value from the compiler.
See also:
TempFileCollection

Return to top


Overloaded Method: ExecWaitWithCapture(
   IntPtr userToken,
   string cmd,
   string currentDir,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
)
Summary
Executes the specified command using the specified user token, current directory, and temporary files; then waits for the call to return, storing output and error information from the compiler in the specified strings.
C# Syntax:
public static int ExecWaitWithCapture(
   IntPtr userToken,
   string cmd,
   string currentDir,
   TempFileCollection tempFiles,
   ref string outputName,
   ref string errorName
);
Parameters:

userToken

The token to start the compiler process with.

cmd

The command to execute.

currentDir

The directory to start the process in.

tempFiles

A TempFileCollection that indicates the temporary files to use.

outputName

A reference to a string that will store the compiler's message output.

errorName

A reference to a string that will store the name of the error or errors encountered.

Return Value:
The return value from the compiler.
See also:
TempFileCollection

Return to top


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~Executor();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetHashCode()
Inherited
See base class member description: System.Object.GetHashCode
C# Syntax:
public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: ToString()
Inherited
See base class member description: System.Object.ToString
C# Syntax:
public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.