The OpenFileMapping function opens a named file-mapping object.
HANDLE OpenFileMapping(
| DWORD dwDesiredAccess, | // access mode |
| BOOL bInheritHandle, | // inherit flag |
| LPCTSTR lpName | // pointer to name of file-mapping object |
| ); |
Parameters
dwDesiredAccess
Specifies the access to the file-mapping object.
Windows NT:
This access is checked against any security descriptor on the target file-mapping object.
Windows 95:
Windows 95 does not support security descriptors on file mapping objects.
This parameter can be one of the following values:
| Value | Meaning |
| FILE_MAP_WRITE | Read-write access. The target file-mapping object must have been created with PAGE_READWRITE protection. A read-write view of the file is mapped. |
| FILE_MAP_READ | Read-only access. The target file-mapping object must have been created with PAGE_READWRITE or PAGE_READ protection. A read-only view of the file is mapped. |
| FILE_MAP_ALL_ACCESS | Same as FILE_MAP_WRITE. |
| FILE_MAP_COPY | Copy-on-write access. The target file-mapping object must have been created with PAGE_WRITECOPY protection. A copy-on-write view of the file is mapped. |
bInheritHandle
Specifies whether the returned handle is to be inherited by a new process during process creation. A value of TRUE indicates that the new process inherits the handle.
lpName
Points to a string that names the file-mapping object to be opened. If there is an open handle to a file-mapping object by this name and the security descriptor on the mapping object does not conflict with the dwDesiredAccess parameter, the open operation succeeds.
Return Values
If the function succeeds, the return value is an open handle to the specified file-mapping object.
If the function fails, the return value is NULL. To get extended error information, call GetLastError.
Remarks
The handle that OpenFileMapping returns can be used with any function that requires a handle to a file-mapping object.
See Also