PDEBUG_EXTENSION_QUERY_VALUE_NAMES callback function (dbgeng.h)

Article
02/22/2024

The DebugExtensionQueryValueNames callback function recovers pseudo-register values.

 CALLBACK* PDEBUG_EXTENSION_QUERY_VALUE_NAMES DebugExtensionQueryValueNames;

Syntax

PDEBUG_EXTENSION_QUERY_VALUE_NAMES PdebugExtensionQueryValueNames;

HRESULT PdebugExtensionQueryValueNames(
  [in]  PDEBUG_CLIENT Client,
  [in]  ULONG Flags,
  [out] PWSTR Buffer,
  [in]  ULONG BufferChars,
  [out] PULONG BufferNeeded
)
{...}

Parameters

[in] Client

A client to use if the extension needs DbgEng functions.

[in] Flags

Provides behavioral flags. This parameter is currently reserved.

[out] Buffer

A string buffer that the caller provides, to be filled with the set of value names that the client wants to expose.

[in] BufferChars

The count of wide characters in Buffer.

[out] BufferNeeded

The number of wide characters that this function needs to complete successfully.

Return value

DebugExtensionQueryValueNames might return one of the following values:

Return code	Description
S_OK	The function was successfully completed.
S_FALSE	The function completed without error, but it obtained only partial results.

This function might also return error values. For more information about possible return values, see Return Values.

Remarks

Value names must start with $$ and have a terminating NULL character. The Buffer string must also be NULL-terminated. For example, Buffer could be "$$myval1\0$$myval2\0\0".

DebugExtensionQueryValueNames is called PDEBUG_EXTENSION_QUERY_VALUE_NAMES in the Dbgeng.h header file.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h