SymReader.GetDocument(String, Guid, Guid, Guid) Method

Definition

Gets a document specified by the URL for the document and optionally the language, language vendor, and type.

public:
 override System::Diagnostics::SymbolStore::ISymbolDocument ^ GetDocument(System::String ^ url, Guid language, Guid languageVendor, Guid documentType);
public:
 virtual System::Diagnostics::SymbolStore::ISymbolDocument ^ GetDocument(System::String ^ url, Guid language, Guid languageVendor, Guid documentType);
public override System.Diagnostics.SymbolStore.ISymbolDocument GetDocument (string url, Guid language, Guid languageVendor, Guid documentType);
public virtual System.Diagnostics.SymbolStore.ISymbolDocument GetDocument (string url, Guid language, Guid languageVendor, Guid documentType);
abstract member GetDocument : string * Guid * Guid * Guid -> System.Diagnostics.SymbolStore.ISymbolDocument
override this.GetDocument : string * Guid * Guid * Guid -> System.Diagnostics.SymbolStore.ISymbolDocument
Public Overrides Function GetDocument (url As String, language As Guid, languageVendor As Guid, documentType As Guid) As ISymbolDocument
Public Overridable Function GetDocument (url As String, language As Guid, languageVendor As Guid, documentType As Guid) As ISymbolDocument

Parameters

url
String

The URL that identifies the document.

language
Guid

The document language. You can specify this parameter as Empty. to indicate any language.

languageVendor
Guid

The identity of the vendor for the document language. You can specify this parameter as Empty to indicate any language vendor.

documentType
Guid

The type of the document. You can specify this parameter as Empty to indicate any document type.

Returns

The document with the specified URL if found in the symbol store, or null if the document does not exist.

Implements

Remarks

The language, languageVendor, and documentType parameters are currently ignored.

Applies to