WindowsInspectString2 function (winstring.h)

Article
02/22/2024

Provides a way to for debuggers to display the value of a Windows Runtime HSTRING in another address space, remotely, or from a dump.

Syntax

HRESULT WindowsInspectString2(
  UINT64                     targetHString,
  USHORT                     machine,
  PINSPECT_HSTRING_CALLBACK2 callback,
  void                       *context,
  UINT32                     *length,
  UINT64                     *targetStringAddress
);

Parameters

targetHString

[in]

The HSTRING to inspect.

machine

The format of the target address space. Valid values are IMAGE_FILE_MACHINE_AMD64 for Win64, IMAGE_FILE_MACHINE_I386 for Win32, or IMAGE_FILE_MACHINE_ARM for 32-bit ARM.

callback

[in]

A callback function to read the string buffer from the target address space. This function is called before the length and targetStringAddress parameters are computed by the WindowsInspectString2 function.

context

[in, optional]

Custom context data passed to the callback.

length

[out]

The length of the string in the target address space, if the call to callback is successful; otherwise, 0.

targetStringAddress

[out]

The target address of the raw PCWSTR, if the call to callback is successful; otherwise, NULL.

Return value

This function can return one of these values.

Return code	Description
E_INVALIDARG	The machine value is not IMAGE_FILE_MACHINE_AMD64, IMAGE_FILE_MACHINE_I386, or IMAGE_FILE_MACHINE_ARM or targetHString is not a correctly formed HSTRING.

Remarks

The WindowsInspectString function passes the input and output pointers as native pointer-sized values. If the current platform is Win32, that function returns an error for processes that are Win64.

WindowsInspectString2 enables cross-architecture debugging by allowing up to 64-bit values when called from both Win32 and Win64 applications.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	winstring.h
Library	RuntimeObject.lib
DLL	ComBase.dll