GetMappedFileName function

Applies to: desktop apps only

Checks whether the specified address is within a memory-mapped file in the address space of the specified process. If so, the function returns the name of the memory-mapped file.

Syntax

DWORD WINAPI GetMappedFileName(
  __in   HANDLE hProcess,
  __in   LPVOID lpv,
  __out  LPTSTR lpFilename,
  __in   DWORD nSize
);

Parameters

hProcess [in]

A handle to the process. The handle must have the PROCESS_QUERY_INFORMATION and PROCESS_VM_READ access rights. For more information, see Process Security and Access Rights.

lpv [in]

The address to be verified.

lpFilename [out]

A pointer to the buffer that receives the name of the memory-mapped file to which the address specified by lpv belongs.

nSize [in]

The size of the lpFilename buffer, in characters.

Return value

If the function succeeds, the return value specifies the length of the string copied to the buffer, in characters.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Starting with Windows 7 and Windows Server 2008 R2, Psapi.h establishes version numbers for the PSAPI functions. The PSAPI version number affects the name used to call the function and the library that a program must load.

If PSAPI_VERSION is 2 or greater, this function is defined as K32GetMappedFileName in Psapi.h and exported in Kernel32.lib and Kernel32.dll. If PSAPI_VERSION is 1, this function is defined as GetMappedFileName in Psapi.h and exported in Psapi.lib and Psapi.dll as a wrapper that calls K32GetMappedFileName.

Programs that must run on earlier versions of Windows as well as Windows 7 and later versions should always call this function as GetMappedFileName. To ensure correct resolution of symbols, add Psapi.lib to the TARGETLIBS macro and compile the program with -DPSAPI_VERSION=1. To use run-time dynamic linking, load Psapi.dll.

Examples

For an example, see Obtaining a File Name From a File Handle.

Requirements

See also

EnumProcesses

Memory-Mapped File Information

PSAPI Functions

Send comments about this topic to Microsoft

Build date: 2/7/2012