ModuleBuilder.DefineDocument Method (String, Guid, Guid, Guid)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Defines a document for source.

Namespace:   System.Reflection.Emit
Assembly:  mscorlib (in mscorlib.dll)

member DefineDocument : 
        url:string *
        language:Guid *
        languageVendor:Guid *
        documentType:Guid -> ISymbolDocumentWriter

Parameters

url
Type: System.String

The URL for the document.

language
Type: System.Guid

The GUID that identifies the document language. This can be Guid.Empty.

languageVendor
Type: System.Guid

The GUID that identifies the document language vendor. This can be Guid.Empty.

documentType
Type: System.Guid

The GUID that identifies the document type. This can be Guid.Empty.

Return Value

Type: System.Diagnostics.SymbolStore.ISymbolDocumentWriter

The defined document.

Exception Condition
ArgumentNullException

url is null. This is a change from earlier versions of the .NET Framework.

InvalidOperationException

This method is called on a dynamic module that is not a debug module.

System_CAPS_importantImportant

Earlier versions of the .NET Framework throw ArgumentException instead of ArgumentNullException when url is null.

The following code sample illustrates the use of DefineDocument to attach an external symbol document (in this case, a raw IL file) to a dynamic module.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show: