This documentation is archived and is not being maintained.

CodeDomProvider.GetCompilerInfo Method

Returns the language provider and compiler configuration settings for the specified language.

Namespace: System.CodeDom.Compiler
Assembly: System (in system.dll)

[ComVisibleAttribute(false)] 
public static CompilerInfo GetCompilerInfo (
	string language
)
/** @attribute ComVisibleAttribute(false) */ 
public static CompilerInfo GetCompilerInfo (
	String language
)
ComVisibleAttribute(false) 
public static function GetCompilerInfo (
	language : String
) : CompilerInfo
Not applicable.

Parameters

language

A language name.

Return Value

A CompilerInfo object populated with settings of the configured CodeDomProvider implementation.

Exception typeCondition

ConfigurationException

The language does not have a configured provider on this computer.

ConfigurationErrorsException

The language is a null reference (Nothing in Visual Basic).

SecurityException

The caller does not have the required permission.

The <system.codedom> Element in the machine configuration file contains the language provider and compiler configuration settings for each CodeDomProvider implementation on the computer. The GetCompilerInfo method searches each provider configuration element for the specified language name. The returned CompilerInfo instance contains the configured language provider and compiler settings.

The IsDefinedLanguage method checks whether at least one provider implementation supports a specific language. You can validate a language name using IsDefinedLanguage before passing it to GetCompilerInfo. This prevents throwing a System.Configuration.ConfigurationException when you access the CompilerInfo instance for an unsupported language name.

If more than one provider implementation is configured for the input language name, GetCompilerInfo returns the settings from the last matching provider configuration element.

Language names are case-insensitive.

The following code example determines the CodeDomProvider implementation for an input language and displays the configured settings for the language provider.

CodeDomProvider provider;

// Check for a provider corresponding to the input language.  
if (CodeDomProvider.IsDefinedLanguage(language))
{
    provider = CodeDomProvider.CreateProvider(language);

    // Display information about this language provider.

    Console.WriteLine("Language provider:  {0}", 
        provider.ToString());
    Console.WriteLine();
    Console.WriteLine("  Default file extension:  {0}", 
        provider.FileExtension);
    Console.WriteLine();

    // Get the compiler settings for this language.

    CompilerInfo langCompilerInfo = CodeDomProvider.GetCompilerInfo(language);
    CompilerParameters langCompilerConfig = langCompilerInfo.CreateDefaultCompilerParameters();

    Console.WriteLine("  Compiler options:        {0}", 
        langCompilerConfig.CompilerOptions);
    Console.WriteLine("  Compiler warning level:  {0}", 
        langCompilerConfig.WarningLevel);
}
else
{
    // Tell the user that the language provider was not found.
    Console.WriteLine("There is no provider configured for input language \"{0}\".", 
        language);
}

  • SecurityAction.LinkDemand  for full trust for the immediate caller. This member cannot be used by partially trusted code.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: