Microsoft.DiaSymReader
Returns the embedded source for specified document.
The document to read source of.
default() if the document doesn't have embedded source,
otherwise byte array segment containing the source.
Get the blob of binary custom debug info for a given method.
Returns compiler version number and name.
Resolves type reference.
The TypeRef metadata token to return the referenced type information for.
The IID of the interface to return in scope. Typically, this would be IID_IMetaDataImport.
An interface to the module scope in which the referenced type is defined.
A pointer to a TypeDef token that represents the referenced type.
TypeDefs define a type within a scope. TypeRefs refer to type-defs in other scopes
and allow you to import a type from another scope. This function attempts to determine
which type-def a type-ref points to.
This resolve (type-ref, this cope) --> (type-def=*ptd, other scope=*ppIScope)
However, this resolution requires knowing what modules have been loaded, which is not decided
until runtime via loader / fusion policy. Thus this interface can't possibly be correct since
it doesn't have that knowledge. Furthermore, when inspecting metadata from another process
(such as a debugger inspecting the debuggee's metadata), this API can be truly misleading.
This API usage should be avoided.
Gets an instance of IMetadataImport.
The implementer is responsible for managing the lifetime of the resulting object.
Returns a pointer to signature blob corresponding to the specified token.
Bytes or null, if the signature is not available.
Minimal implementation of IMetadataImport that implements APIs used by SymReader.
Minimal implementation of IMetadataImport that implements APIs used by SymReader and SymWriter.
Get the file name for the line associated with offset dwOffset.
Get the Line information associated with .
If is not a sequence point it is associated with the previous one.
provides the associated sequence point.
Get the number of Documents that this method has lines in.
Get the documents this method has lines in.
Get the smallest start line and largest end line, for the method, in a specific document.
Given a metadata interface and a file name, returns a new instance of
that will read the debugging symbols associated with the specified PE file.
An instance of IMetadataImport providing metadata for the specified PE file.
PE file path.
Alternate path to search for debug data.
The new reader instance.
Given a metadata interface and a stream that contains
the symbol store, returns the
that will read the debugging symbols from the given
symbol store.
An instance of IMetadataImport providing metadata for the corresponding PE file.
PDB stream.
The new reader instance.
Given a metadata interface and a file name, returns the
correct that will read the debugging symbols
associated with the module.
An instance of IMetadataImport providing metadata for the specified PE file.
PE file path.
Alternate path to search for debug data.
The new reader instance.
Given a metadata interface and a stream that contains
the symbol store, returns the
that will read the debugging symbols from the given
symbol store.
An instance of IMetadataImport providing metadata for the corresponding PE file.
PDB stream.
The new reader instance.
Given a metadata interface and a file name, returns the
interface that will read the debugging symbols associated
with the module.
This version of the function can search for the PDB in areas other than
right next to the module, controlled by the .
If a is provided, those directories will always be searched.
An instance of IMetadataImport providing metadata for the specified PE file.
PE file path.
Alternate path to search for debug data.
Search policy.
The new reader instance.
Given a metadata interface and a file name, returns the
correct that will read the debugging symbols
associated with the module.
An instance of IMetadataImport providing metadata for the specified PE file.
PE file path.
Alternate path to search for debug data.
The new reader instance.
Given a metadata interface and a stream that contains
the symbol store, returns the
that will read the debugging symbols from the given
symbol store.
An instance of IMetadataImport providing metadata for the corresponding PE file.
PDB stream.
The new reader instance.
Given a metadata interface and a file name, returns the
interface that will read the debugging symbols associated
with the module.
This version of the function can search for the PDB in areas other than
right next to the module, controlled by the .
If a is provided, those directories will always be searched.
An instance of IMetadataImport providing metadata for the specified PE file.
PE file path.
Alternate path to search for debug data.
Search policy.
The new reader instance.
Given a metadata interface and a file name, returns the
correct that will read the debugging symbols
associated with the module.
An instance of IMetadataImport providing metadata for the specified PE file.
PE file path.
Alternate path to search for debug data.
The new reader instance.
Given a metadata interface and a stream that contains
the symbol store, returns the
that will read the debugging symbols from the given
symbol store.
An instance of IMetadataImport providing metadata for the corresponding PE file.
PDB stream.
The new reader instance.
Given a metadata interface and a file name, returns the
interface that will read the debugging symbols associated
with the module.
This version of the function can search for the PDB in areas other than
right next to the module, controlled by the .
If a is provided, those directories will always be searched.
An instance of IMetadataImport providing metadata for the specified PE file.
PE file path.
Alternate path to search for debug data.
Search policy.
The new reader instance.
Creates a new for the specified PDB file.
Provider of a metadata importer for the corresponding PE file.
The importer is only constructed if the operation performed on the SymReader requires access
to the metadata.
PDB file path.
The new reader instance.
E_INVALIDARG
is null, or
is null or empty.
Another error code describing failure to open the file.
Creates a new for the specified PDB file.
Provider of a metadata importer for the corresponding PE file.
The importer is only constructed if the operation performed on the SymReader requires access
to the metadata.
PDB stream.
The new reader instance.
E_INVALIDARG
is null, or
is null.
Another error code describing failure to open the file.
Applies EnC edit.
Gets the number of local variables of the latest version of the specified method.
Gets local variables of the latest version of the specified method.
Allows updating the line info for a method that has not been recompiled,
but whose lines have moved independently. A delta for each statement is allowed.
Gets the IL offset within the method that corresponds to the specified position.
The document for which the offset is requested.
The document line corresponding to the offset.
The document column corresponding to the offset.
The offset within the specified document.
HResult.
Gets an array of start and end offset pairs that correspond to the ranges of IL that a given position covers within this method.
Gets method parameters.
Gets the start and end positions for the source of the current method.
The starting and ending source documents.
The starting and ending lines in the corresponding source documents.
The starting and ending columns in the corresponding source documents.
true if the positions were defined; otherwise, false.
HResult
Gets the IL offset within the method that corresponds to the specified position.
The document for which the offset is requested.
The document line corresponding to the offset.
The document column corresponding to the offset.
The offset within the specified document.
HResult.
Gets an array of start and end offset pairs that correspond to the ranges of IL that a given position covers within this method.
Gets method parameters.
Gets the start and end positions for the source of the current method.
The starting and ending source documents.
The starting and ending lines in the corresponding source documents.
The starting and ending columns in the corresponding source documents.
true if the positions were defined; otherwise, false.
HResult
Get the token of the local signature.
Local signature token (StandAloneSig), or 0 if the method doesn't have any local variables.
S_OK if the method has a local signature,
S_FALSE if the method doesn't have a local signature,
E_* if an error occurs while reading the signature.
Gets a custom debug information based upon its name and an EnC 1-based version number.
Gets a custom debug information based upon its name and an EnC 1-based version number.
Gets a custom debug information based upon its name and an EnC 1-based version number.
Gets a custom debug information based upon its name and an EnC 1-based version number.
Checks whether the id stored in the PDB matches the PDB ID stored in the PE/COFF Debug Directory.
Returns a pointer to Portable Debug Metadata. Only available for Portable PDBs.
A pointer to memory where Portable Debug Metadata start. The memory is owned by the SymReader and
valid until is invoked.
Null if the PDB is not portable.
Size of the metadata block.
Returns a pointer to Source Server data stored in the PDB (source link data for Portable PDB or srcsvr section for Windows PDB).
A pointer to memory where Source Server data start. The memory is owned by the SymReader and
valid until is invoked.
Null if the PDB doesn't contain Source Server data.
Size of the data in bytes.
This method is a replacement for .
The reader doesn't implement since
the format of the returned data is completely different for Portable PDBs, which the callers wouldn't expect.
The native diasymreader may implement by simply calling
to .
Gets a custom debug information based upon its name and an EnC 1-based version number.
Gets a custom debug information based upon its name and an EnC 1-based version number.
Checks whether the id stored in the PDB matches the PDB ID stored in the PE/COFF Debug Directory.
Returns a pointer to Portable Debug Metadata. Only available for Portable PDBs.
A pointer to memory where Portable Debug Metadata start. The memory is owned by the SymReader and
valid until is invoked.
Null if the PDB is not portable.
Size of the metadata block.
S_OK if the PDB is portable, S_FALSE if it isn't.
If the store was updated via
returns the metadata of the latest update.
Returns a pointer to Source Server data stored in the PDB.
A pointer to memory where Source Server data start. The memory is owned by the SymReader and
valid until is invoked.
Null if the PDB doesn't contain Source Server data.
Size of the data in bytes.
S_OK if the PDB contains Source Server data, S_FALSE if it doesn't.
Returns a pointer to Portable Debug Metadata of the specified version (EnC generation). Only available for Portable PDBs.
EnC 1-based version number. Version 1 corresponds to the baseline.
A pointer to memory where Portable Debug Metadata start. The memory is owned by the SymReader and
valid until is invoked.
Null if the PDB is not portable.
Size of the metadata block.
Returns compiler version number and name.
Returns the source server data for the module.
Length of the data.
Pointer to a newly allocated memory containing the data.
Caller must free using .
S_OK on success.
Line deltas allow a compiler to omit functions that have not been modified from
the pdb stream provided the line information meets the following condition.
The correct line information can be determined with the old pdb line info and
one delta for all lines in the function.
creation options.
Default options.
Use environment variable MICROSOFT_DIASYMREADER_NATIVE_ALT_LOAD_PATH, which specifies a load directory to locate Microsoft.DiaSymReader.Native.{platform}.dll
if it fails to load from or .
Loads the native library only from the alternative load directory if environment variable MICROSOFT_DIASYMREADER_NATIVE_USE_ALT_LOAD_PATH_ONLY is also set to 1.
Use COM registry to locate an implementation of the reader.
Creates instance and initializes it with specified PDB stream and metadata import object.
Windows PDB stream.
IMetadataImport implementation.
Options.
Tries to load the implementation of the PDB reader from Microsoft.DiaSymReader.Native.{platform}.dll library first.
It searches for this library in the directory Microsoft.DiaSymReader.dll is loaded from,
the application directory, the %WinDir%\System32 directory, and user directories in the DLL search path, in this order.
If not found in the above locations and option is specified
the directory specified by MICROSOFT_DIASYMREADER_NATIVE_ALT_LOAD_PATH environment variable is also searched.
If the Microsoft.DiaSymReader.Native.{platform}.dll library can't be found and
option is specified checks if the PDB reader is available from a globally registered COM object. This COM object is provided
by .NET Framework and has limited functionality (up to ).
is null.
is null.
The SymReader implementation is not available or failed to load.
The implementation doesn't support specified interface.
Creates instance and initializes it with specified PDB stream and metadata provider.
Windows PDB stream.
implementation.
Options.
Tries to load the implementation of the PDB reader from Microsoft.DiaSymReader.Native.{platform}.dll library first.
It searches for this library in the directory Microsoft.DiaSymReader.dll is loaded from,
the application directory, the %WinDir%\System32 directory, and user directories in the DLL search path, in this order.
If not found in the above locations and option is specified
the directory specified by MICROSOFT_DIASYMREADER_NATIVE_ALT_LOAD_PATH environment variable is also searched.
If the Microsoft.DiaSymReader.Native.{platform}.dll library can't be found and
option is specified checks if the PDB reader is available from a globally registered COM object. This COM object is provided
by .NET Framework and has limited functionality (up to ).
is null.
is null.
Creates a minimal implementation of IMetadataImport required for reading PDBs based on given .
Reads metadata.
An instance of IMetadataImport.
is null.
Query the registry for symbol search paths.
Access a symbol server.
Look at the path specified in Debug Directory.
Look for PDB in the place where the exe is.
A COM IStream implementation over memory. Supports just enough for DiaSymReader's PDB writing.
Also tuned for performance:
1. SetSize (and Seek beyond the length) is very fast and doesn't re-allocate the underlying memory.
2. Read and Write are optimized to avoid copying (see )
3. Allocates in chunks instead of a contiguous buffer to avoid re-alloc and copy costs when growing.
Attempts to read all of the requested bytes from the stream into the buffer
The number of bytes read. Less than will
only be returned if the end of stream is reached before all bytes can be read.
Unlike it is not guaranteed that
the stream position or the output buffer will be unchanged if an exception is
returned.
The actual number of bytes read can be fewer than the number of bytes requested
if an error occurs or if the end of the stream is reached during the read operation.
This is a re-definition of COM's IStream interface. The important change is that
the Read and Write methods take an instead of a byte[] to avoid the
allocation cost when called from native code.
Adds compiler version number and name.
The highest version of the interface available on Desktop FX 4.0+.
has type , rather than ,
so that we can do custom marshalling of . Unfortunately, .NET marshals
s as the number of days since 1899/12/30, whereas the native VB compiler
marshalled them as the number of ticks since the Unix epoch (i.e. a much, much larger number).
Open a special custom data section to emit token to source span mapping information into.
Opening this section while a method is already open or vice versa is an error.
Close the special custom data section for token to source span mapping
information. Once it is closed no more mapping information can be added.
Maps the given metadata token to the given source line span in the specified source file.
Must be called between calls to and .
The highest version of the interface available in Microsoft.DiaSymReader.Native.
A struct with the same size and layout as the native VARIANT type:
2 bytes for a discriminator (i.e. which type of variant it is).
6 bytes of padding
8 or 16 bytes of data
This field determines the size of the struct
(16 bytes on 32-bit platforms, 24 bytes on 64-bit platforms).
This type is 8 bytes on a 32-bit platforms and 16 bytes on 64-bit platforms.
Windows PDB writer.
Disposes the writer.
Gets the raw data blobs that comprise the written PDB content so far.
Writes the PDB data to specified stream. Once called no more changes to the data can be made using this writer.
May be called multiple times. Always writes the same data.
Stream to write PDB data to.
Error occurred while writing data to the stream.
The capacity of document table.
Whenever a document is defined an entry is added to this table.
If the number of documents is known upfront setting this value may reduce memory consumption.
Defines a source document.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Defines sequence points.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Opens a method.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Closes a method previously open using .
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Opens a local scope.
Object has been disposed.
Writes are not allowed to the underlying stream.
Closes a local scope previously open using .
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Defines a local variable.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Defines a local constant.
Name of the constant.
Value.
Standalone signature token encoding the static type of the constant.
False if the constant representation is too long (e.g. long string).
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
is null
Adds namespace import.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
is null
Sets method async information.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
or is null
or differ in length.
Associates custom debug information blob with the current method.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
is null
Designates specified method as an entry point.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Updates the current PDB signature.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Gets the current PDB signature.
Object has been disposed.
Error occurred while writing PDB data.
Sets source server data blob (srcsvr stream).
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
is null
Sets source link data blob (sourcelink stream).
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
is null
Opens a map of tokens to source spans.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Maps specified token to a source span.
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
doesn't correspond to any defined document.
Closes map of tokens to source spans previously opened using .
Object has been disposed.
Writes are not allowed to the underlying stream.
Error occurred while writing PDB data.
Writes compiler version and name to the PDB.
Major version
Minor version
Build
Revision
Compiler name
Object has been disposed.
Error occurred while writing PDB data.
The PDB writer does not support adding compiler info.
is null.
creation options.
Default options.
Use environment variable MICROSOFT_DIASYMREADER_NATIVE_ALT_LOAD_PATH, which specifies a load directory to locate Microsoft.DiaSymReader.Native.{platform}.dll
if it fails to load from or .
Loads the native library only from the alternative load directory if environment variable MICROSOFT_DIASYMREADER_NATIVE_USE_ALT_LOAD_PATH_ONLY is also set to 1.
Use COM registry to locate an implementation of the writer.
Create a deterministic PDB writer.
Exception reported when PDB write operation fails.
The name of the module that implements the underlying PDB writer (e.g. diasymreader.dll), or null if not available.
Creates a Windows PDB writer.
implementation.
Options.
Tries to load the implementation of the PDB writer from Microsoft.DiaSymReader.Native.{platform}.dll library first.
It searches for this library in the directory Microsoft.DiaSymReader.dll is loaded from,
the application directory, the %WinDir%\System32 directory, and user directories in the DLL search path, in this order.
If not found in the above locations and option is specified
the directory specified by MICROSOFT_DIASYMREADER_NATIVE_ALT_LOAD_PATH environment variable is also searched.
If the Microsoft.DiaSymReader.Native.{platform}.dll library can't be found and
option is specified checks if the PDB reader is available from a globally registered COM object. This COM object is provided
by .NET Framework and has limited functionality (features like determinism and source link are not supported).
is null.
The SymWriter implementation is not available or failed to load.
Error creating the PDB writer. See inner exception for root cause.
Writes the content to the given stream. The writer is disposed and can't be used for further writing.