MapAndLoad Function

Maps an image and preloads data from the mapped file.

BOOL MapAndLoad(
  __in          PSTR ImageName,
  __in          PSTR DllPath,
  __out         PLOADED_IMAGE LoadedImage,
  __in          BOOL DotDll,
  __in          BOOL ReadOnly
);

Parameters

ImageName

The file name of the image (executable file or DLL) that is loaded.

DllPath

The path used to locate the image if the name provided cannot be found. If this parameter is NULL, then the search path rules set using the SearchPath function apply.

LoadedImage

A pointer to a LOADED_IMAGE structure that receives information about the image after it is loaded.

DotDll

The default extension to be used if the image name does not contain a file extension. If the value is TRUE, a .DLL extension is used. If the value is FALSE, then an .EXE extension is used.

ReadOnly

The access mode. If this value is TRUE, the file is mapped for read-access only. If the value is FALSE, the file is mapped for read and write access.

Return Value

If the function succeeds, the return value is TRUE.

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

Remarks

The MapAndLoad function maps an image and preloads data from the mapped file. The corresponding function, UnMapAndLoad, must be used to deallocate all resources that are allocated by the MapAndLoad function.

All ImageHlp 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

See Also

ImageHlp FunctionsLOADED_IMAGE
UnMapAndLoad

Send comments about this topic to Microsoft

Build date: 9/25/2007