heapapi.h

/******************************************************************************** * * * HeapApi.h -- ApiSet Contract for api-ms-win-core-heap-l1 * * * * Copyright (c) Microsoft Corporation. All rights reserved. * * * ********************************************************************************/

#ifdef _MSC_VER

#pragma once

#endif // _MSC_VER

#ifndef _HEAPAPI_H_

#define _HEAPAPI_H_

#include <apiset.h>

#include <apisetcconv.h>

#include <minwindef.h>

#include <minwinbase.h>

#if _MSC_VER < 1900

#define DECLSPEC_ALLOCATOR #else

#define DECLSPEC_ALLOCATOR __declspec(allocator) #endif

#ifdef __cplusplus

extern

"C"

{

#endif

#if _MSC_VER >= 1200

#pragma warning(push)

#pragma warning(disable:4820) // padding added after data member #endif

#pragma warning(disable:

4820

)

#pragma region Desktop Family or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

// typdefs

typedef

struct

_HEAP_SUMMARY

{

DWORD

;

SIZE_T

cbAllocated

;

SIZE_T

cbCommitted

;

SIZE_T

cbReserved

;

SIZE_T

cbMaxReserve

; }

HEAP_SUMMARY

, *

PHEAP_SUMMARY

;

typedef

PHEAP_SUMMARY

LPHEAP_SUMMARY

;

#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

#pragma endregion #pragma region Application Family or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

// Prototypes

WINBASEAPI

__declspec

(dllimport)

_Ret_maybenull_

HANDLE

WINAPI

__stdcall

HeapCreate

(

_In_ DWORD flOptions,

DWORD

flOptions

_In_ SIZE_T dwInitialSize,

SIZE_T

dwInitialSize

_In_ SIZE_T dwMaximumSize

SIZE_T

dwMaximumSize

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

HeapDestroy

(

_In_ HANDLE hHeap

HANDLE

hHeap

);

WINBASEAPI

__declspec

(dllimport)

_Ret_maybenull_

_Post_writable_byte_size_(dwBytes)

DECLSPEC_ALLOCATOR

__declspec

(allocator)

LPVOID

WINAPI

__stdcall

HeapAlloc

(

_In_ HANDLE hHeap,

HANDLE

hHeap

_In_ DWORD dwFlags,

DWORD

dwFlags

_In_ SIZE_T dwBytes

SIZE_T

dwBytes

);

WINBASEAPI

__declspec

(dllimport)

_Success_(return != 0)

_Ret_maybenull_

_Post_writable_byte_size_(dwBytes)

DECLSPEC_ALLOCATOR

__declspec

(allocator)

LPVOID

WINAPI

__stdcall

HeapReAlloc

(

_Inout_ HANDLE hHeap,

HANDLE

hHeap

_In_ DWORD dwFlags,

DWORD

dwFlags

_Frees_ptr_opt_ LPVOID lpMem,

LPVOID

lpMem

_In_ SIZE_T dwBytes

SIZE_T

dwBytes

);

WINBASEAPI

__declspec

(dllimport)

_Success_(return != FALSE)

BOOL

WINAPI

__stdcall

HeapFree

(

_Inout_ HANDLE hHeap,

HANDLE

hHeap

_In_ DWORD dwFlags,

DWORD

dwFlags

__drv_freesMem(Mem) _Frees_ptr_opt_ LPVOID lpMem

LPVOID

lpMem

);

WINBASEAPI

__declspec

(dllimport)

SIZE_T

WINAPI

__stdcall

HeapSize

(

_In_ HANDLE hHeap,

HANDLE

hHeap

_In_ DWORD dwFlags,

DWORD

dwFlags

_In_ LPCVOID lpMem

LPCVOID

lpMem

);

WINBASEAPI

__declspec

(dllimport)

HANDLE

WINAPI

__stdcall

GetProcessHeap

(

VOID

void

);

WINBASEAPI

__declspec

(dllimport)

SIZE_T

WINAPI

__stdcall

HeapCompact

(

_In_ HANDLE hHeap,

HANDLE

hHeap

_In_ DWORD dwFlags

DWORD

dwFlags

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

HeapSetInformation

(

_In_opt_ HANDLE HeapHandle,

HANDLE

HeapHandle

_In_ HEAP_INFORMATION_CLASS HeapInformationClass,

HEAP_INFORMATION_CLASS

HeapInformationClass

_In_reads_bytes_opt_(HeapInformationLength) PVOID HeapInformation,

PVOID

HeapInformation

_In_ SIZE_T HeapInformationLength

SIZE_T

HeapInformationLength

);

#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

#pragma endregion #pragma region Desktop Family or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

HeapValidate

(

_In_ HANDLE hHeap,

HANDLE

hHeap

_In_ DWORD dwFlags,

DWORD

dwFlags

_In_opt_ LPCVOID lpMem

LPCVOID

lpMem

);

#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

#pragma endregion #pragma region Desktop Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)

BOOL

WINAPI

__stdcall

HeapSummary

(

_In_ HANDLE hHeap,

HANDLE

hHeap

_In_ DWORD dwFlags,

DWORD

dwFlags

_Out_ LPHEAP_SUMMARY lpSummary

LPHEAP_SUMMARY

lpSummary

);

#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)

#pragma endregion #pragma region Desktop Family or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

DWORD

WINAPI

__stdcall

GetProcessHeaps

(

_In_ DWORD NumberOfHeaps,

DWORD

NumberOfHeaps

_Out_writes_to_(NumberOfHeaps,return) PHANDLE ProcessHeaps

PHANDLE

ProcessHeaps

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

HeapLock

(

_In_ HANDLE hHeap

HANDLE

hHeap

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

HeapUnlock

(

_In_ HANDLE hHeap

HANDLE

hHeap

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

HeapWalk

(

_In_ HANDLE hHeap,

HANDLE

hHeap

_Inout_ LPPROCESS_HEAP_ENTRY lpEntry

LPPROCESS_HEAP_ENTRY

lpEntry

);

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

HeapQueryInformation

(

_In_opt_ HANDLE HeapHandle,

HANDLE

HeapHandle

_In_ HEAP_INFORMATION_CLASS HeapInformationClass,

HEAP_INFORMATION_CLASS

HeapInformationClass

_Out_writes_bytes_to_opt_(HeapInformationLength,*ReturnLength) PVOID HeapInformation,

PVOID

HeapInformation

_In_ SIZE_T HeapInformationLength,

SIZE_T

HeapInformationLength

_Out_opt_ PSIZE_T ReturnLength

PSIZE_T

ReturnLength

);

#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

#pragma endregion

// HeapSummary() is in minwinbase.w within ;beg_internal tags. Has to stay there for downlevel reasons.

#if _MSC_VER >= 1200

#pragma warning(pop)

#endif

#ifdef __cplusplus

}

#endif

#endif // _HEAPAPI_H_