Export (0) Print
Expand All

Regex.CompileToAssembly Method (RegexCompilationInfo(), AssemblyName, CustomAttributeBuilder(), String)

Compiles one or more specified Regex objects and a specified resource file to a named assembly with the specified attributes.

Namespace:  System.Text.RegularExpressions
Assembly:  System (in System.dll)

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort := True)> _
Public Shared Sub CompileToAssembly ( _
	regexinfos As RegexCompilationInfo(), _
	assemblyname As AssemblyName, _
	attributes As CustomAttributeBuilder(), _
	resourceFile As String _
)

Parameters

regexinfos
Type: System.Text.RegularExpressions.RegexCompilationInfo()

An array that describes the regular expressions to compile.

assemblyname
Type: System.Reflection.AssemblyName

The file name of the assembly.

attributes
Type: System.Reflection.Emit.CustomAttributeBuilder()

An array that defines the attributes to apply to the assembly.

resourceFile
Type: System.String

The name of the Win32 resource file to include in the assembly.

ExceptionCondition
ArgumentException

The value of the assemblyname parameter's AssemblyName.Name property is an empty or null string.

-or-

The regular expression pattern of one or more objects in regexinfos contains invalid syntax.

ArgumentNullException

assemblyname or regexinfos is Nothing.

COMException

The resourceFile parameter designates an invalid Win32 resource file.

FileNotFoundException

The file designated by the resourceFile parameter cannot be found.

The CompileToAssembly(RegexCompilationInfo(), AssemblyName, CustomAttributeBuilder(), String) method generates a .NET Framework assembly in which each regular expression defined in the regexinfos array is represented by a class. Typically, the CompileToAssembly(RegexCompilationInfo(), AssemblyName, CustomAttributeBuilder(), String) method is called from a separate application that generates an assembly of compiled regular expressions. Each regular expression included in the assembly has the following characteristics:

  • It is derived from the Regex class.

  • It is assigned the fully qualified name that is defined by the fullnamespace and name parameters of its corresponding RegexCompilationInfo object.

  • It has a default (or parameterless) constructor.

Ordinarily, the code that instantiates and uses the compiled regular expression is found in an assembly or application that is separate from the code that creates the assembly.

Because the CompileToAssembly method generates a .NET Framework assembly from a method call instead of using a particular language's class definition keyword (such as class in C# or ClassEnd Class in Visual Basic), it does not allow .NET Framework attributes to be assigned to the assembly by using the development language's standard attribute syntax. The attributes parameter provides an alternative method for defining the attributes that apply to the assembly. For each attribute that you want to apply to the assembly, do the following:

  1. Create an array of Type objects representing the parameter types of the attribute constructor that you want to call.

  2. Retrieve a Type object representing the attribute class that you want to apply to the new assembly.

  3. Call the GetConstructor method of the attribute Type object to retrieve a ConstructorInfo object representing the attribute constructor that you want to call. Pass the GetConstructor method the array of Type objects that represents the constructor's parameter types

  4. Create a Object array that defines the parameters to pass to the attribute's constructor.

  5. Instantiate a CustomAttributeBuilder object by passing its constructor the ConstructorInfo object retrieved in step 3 and the Object array created in step 4.

You can then pass an array of these CustomAttributeBuilder objects instead of the attributes parameter to the CompileToAssembly(RegexCompilationInfo(), AssemblyName, CustomAttributeBuilder(), String) method.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Notes to Callers

If you are developing on a system that has .NET Framework 4.5 or its point releases installed, you target .NET Framework 4, and you use the CompileToAssembly method to create an assembly that contains compiled regular expressions. Trying to use one of the regular expressions in that assembly on a system that has .NET Framework 4 throws an exception. To work around this problem, you can do either of the following:

  • Build the assembly that contains the compiled regular expressions on a system that has .NET Framework 4 instead of later versions installed.

  • Instead of calling CompileToAssembly and retrieving the compiled regular expression from an assembly, use either static or instance Regex methods with the RegexOptions.Compiled option when you instantiate a Regex object or call a regular expression pattern matching method.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft