DkmSourceFileId Class

Definition

Identifies a source file and provides the information which a symbol handler could use to search a symbol file (PDB) for information on this source file.

public ref class DkmSourceFileId
[Windows::Foundation::Metadata::WebHostHidden]
public ref class DkmSourceFileId
[Windows::Foundation::Metadata::WebHostHidden]
class DkmSourceFileId
[System.Runtime.InteropServices.Guid("a892d8cf-b6fd-7e20-e0da-6ceca6a7c0c4")]
public class DkmSourceFileId
[<System.Runtime.InteropServices.Guid("a892d8cf-b6fd-7e20-e0da-6ceca6a7c0c4")>]
type DkmSourceFileId = class
Public Class DkmSourceFileId
Inheritance
DkmSourceFileId
Attributes

Properties

AdditionalChecksums

[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.

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

DocumentName

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.

MD5HashPart

[Optional] MD5 hash value for this document.

ScriptDocument

[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.

SHA1HashPart

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

Methods

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).

Applies to