XMemGetWin32HeapName

Retrieves the name of a Win32 heap

Syntax

BOOL XMemGetWin32HeapName(
  HANDLE Heap,
  PSTR Buffer,
  SIZE_T SizeOfBuffer,
  PSIZE_T ReturnLength
)

Parameters

Heap   _In_
Type: HANDLE Heap Handle Buffer   _Out_
Type: PCSTR Buffer to return the heap name in SizeOfBuffer   _In_
Type: SIZE_T Size in bytes of Buffer ReturnLength   _Out_opt_
Type: PSIZE_T Number of bytes returned including the NULL terminator

Return value

Type: BOOL On success XMemGetWin32HeapName returns TRUE. If the function fails, the return value is FALSE. To get extended error information, call GetLastError.

Remarks

The heap name is limited to 8 characters not including the NULL terminator. XMemGetWin32HeapName will always NULL terminate the supplied buffer upon success. To ensure the full name is retrieved, supply a buffer that is at least 9 bytes.

Requirements

Header: xmem.h Library: xmem.lib Supported platforms: XBOX One family consoles and XBOX Series consoles

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also