ImageDirectoryEntryToData function (dbghelp.h)

Article
10/13/2021

Obtains access to image-specific data.

This function has been superseded by the ImageDirectoryEntryToDataEx function. Use ImageDirectoryEntryToDataEx to retrieve the section header.

Syntax

PVOID IMAGEAPI ImageDirectoryEntryToData(
  [in]  PVOID   Base,
  [in]  BOOLEAN MappedAsImage,
  [in]  USHORT  DirectoryEntry,
  [out] PULONG  Size
);

Parameters

[in] Base

The base address of the image.

[in] MappedAsImage

If this parameter is TRUE, the file is mapped by the system as an image. If the flag is FALSE, the file is mapped as a data file by the MapViewOfFile function.

[in] DirectoryEntry

The index number of the desired directory entry. This parameter can be one of the following values.

Value	Meaning
IMAGE_DIRECTORY_ENTRY_ARCHITECTURE 7	Architecture-specific data
IMAGE_DIRECTORY_ENTRY_BASERELOC 5	Base relocation table
IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT 11	Bound import directory
IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR 14	COM descriptor table
IMAGE_DIRECTORY_ENTRY_DEBUG 6	Debug directory
IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT 13	Delay import table
IMAGE_DIRECTORY_ENTRY_EXCEPTION 3	Exception directory
IMAGE_DIRECTORY_ENTRY_EXPORT 0	Export directory
IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8	The relative virtual address of global pointer
IMAGE_DIRECTORY_ENTRY_IAT 12	Import address table
IMAGE_DIRECTORY_ENTRY_IMPORT 1	Import directory
IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10	Load configuration directory
IMAGE_DIRECTORY_ENTRY_RESOURCE 2	Resource directory
IMAGE_DIRECTORY_ENTRY_SECURITY 4	Security directory
IMAGE_DIRECTORY_ENTRY_TLS 9	Thread local storage directory

[out] Size

A pointer to a variable that receives the size of the data for the directory entry, in bytes.

Return value

If the function succeeds, the return value is a pointer to the directory entry's data.

If the function fails, the return value is NULL. To retrieve extended error information, call GetLastError.

Remarks

The ImageDirectoryEntryToData function is used to obtain access to image-specific data.

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

Requirements

Requirement	Value
Target Platform	Windows
Header	dbghelp.h
Library	Dbghelp.lib
DLL	Dbghelp.dll
Redistributable	DbgHelp.dll 5.1 or later