DkmSourceFileId.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Symbols

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(String, DkmScriptDocument, DkmSourceFileId+MD5Hash, DkmSourceFileId+SHA1Hash)	Create a new DkmSourceFileId object instance.
Create(String, DkmScriptDocument, ReadOnlyCollection<DkmSourceFileHash>, DkmSourceFileId+MD5Hash, DkmSourceFileId+SHA1Hash)	Create a new DkmSourceFileId object instance. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).

Create(String, DkmScriptDocument, DkmSourceFileId+MD5Hash, DkmSourceFileId+SHA1Hash)

Create a new DkmSourceFileId object instance.

public:
 static Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId ^ Create(System::String ^ DocumentName, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocument ^ ScriptDocument, Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId::MD5Hash ^ MD5Hash, Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId::SHA1Hash ^ SHA1Hash);

public static Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId Create (string DocumentName, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument? ScriptDocument, Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.MD5Hash? MD5Hash, Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.SHA1Hash? SHA1Hash);

static member Create : string * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument * Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.MD5Hash * Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.SHA1Hash -> Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId

Public Shared Function Create (DocumentName As String, ScriptDocument As DkmScriptDocument, MD5Hash As DkmSourceFileId.MD5Hash, SHA1Hash As DkmSourceFileId.SHA1Hash) As DkmSourceFileId

Parameters

DocumentName

String

[In] Name of the source file. This is generally a full path, but in some scenarios it make be a partial path or just a name with extension (ex: example.cpp). In the case of a dynamic document (ex: running script from internet explorer) 'Path' could be a URL rather than a local file path.

ScriptDocument

DkmScriptDocument

[In,Optional] Script document object which this DkmSourceFileId wraps. For requests to find document requests, this can be non-NULL when the text position to search for is from the dynamic view of a document. For address->text position requests, this will be non-null when the the address is in a script document.

MD5Hash

DkmSourceFileId.MD5Hash

[In,Optional] MD5 hash value for this document.

SHA1Hash

DkmSourceFileId.SHA1Hash

[In,Optional] SHA-1 hash value for this document.

Returns

DkmSourceFileId

[Out] Result of this method call.

Create(String, DkmScriptDocument, ReadOnlyCollection<DkmSourceFileHash>, DkmSourceFileId+MD5Hash, DkmSourceFileId+SHA1Hash)

Create a new DkmSourceFileId object instance.

This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).

public:
 static Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId ^ Create(System::String ^ DocumentName, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocument ^ ScriptDocument, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileHash ^> ^ AdditionalChecksums, Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId::MD5Hash ^ MD5Hash, Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId::SHA1Hash ^ SHA1Hash);

public static Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId Create (string DocumentName, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument? ScriptDocument, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileHash>? AdditionalChecksums, Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.MD5Hash? MD5Hash, Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.SHA1Hash? SHA1Hash);

static member Create : string * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileHash> * Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.MD5Hash * Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId.SHA1Hash -> Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId

Public Shared Function Create (DocumentName As String, ScriptDocument As DkmScriptDocument, AdditionalChecksums As ReadOnlyCollection(Of DkmSourceFileHash), MD5Hash As DkmSourceFileId.MD5Hash, SHA1Hash As DkmSourceFileId.SHA1Hash) As DkmSourceFileId

Parameters

DocumentName

String

[In] Name of the source file. This is generally a full path, but in some scenarios it make be a partial path or just a name with extension (ex: example.cpp). In the case of a dynamic document (ex: running script from internet explorer) 'Path' could be a URL rather than a local file path.

ScriptDocument

DkmScriptDocument

[In,Optional] Script document object which this DkmSourceFileId wraps. For requests to find document requests, this can be non-NULL when the text position to search for is from the dynamic view of a document. For address->text position requests, this will be non-null when the the address is in a script document.

AdditionalChecksums

ReadOnlyCollection<DkmSourceFileHash>

[In,Optional] Additional checksums that can be used to identify this source file. This is used for additional hash algorithms beyond SHA1 and MD5. It is also used to allow for multiple hash values for the same document. This can be used when the same document has semantically identical content but may have different on-disk bytes. For example, this can be used to provide another hash value for alternate line endings.

MD5Hash

DkmSourceFileId.MD5Hash

[In,Optional] MD5 hash value for this document.

SHA1Hash

DkmSourceFileId.SHA1Hash

[In,Optional] SHA-1 hash value for this document.

Returns

DkmSourceFileId

[Out] Result of this method call.