IDebugDataSpaces3::ReadTagged method (dbgeng.h)

  • Article

The ReadTagged method reads the tagged data that might be associated with a debugger session.

Syntax

HRESULT ReadTagged(
  [in]            LPGUID Tag,
  [in]            ULONG  Offset,
  [out, optional] PVOID  Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG TotalSize
);

Parameters

[in] Tag

Specifies the GUID identifying the data requested.

[in] Offset

Specifies the offset within the data to read.

[out, optional] Buffer

Receives the data. If Buffer is NULL, the data is not returned.

[in] BufferSize

Specifies the size in bytes of the buffer Buffer. This is the maximum number of bytes that will be returned.

[out, optional] TotalSize

Receives the total size in bytes of the data specified by Tag.

Return value

Return code Description
S_OK
 The method was successful.
E_NOINTERFACE
 No data identified by Tag could be found.
 

This method can also return error values. See Return Values for more details.

Remarks

Some debugger sessions have arbitrary additional data available. For example, when a dump file is created, additional dump information files containing extra information may also be created. This additional data is tagged with a global unique identifier and can only be retrieved via the tag.

LPGUID is a pointer to a 128-bit unique identifier. It is defined in the Microsoft Windows SDK header file guiddef.h.

Requirements

Requirement Value
Target Platform Desktop
Header dbgeng.h (include Dbgeng.h)

See also

GetNextTagged

IDebugDataSpaces3

IDebugDataSpaces4