Функция CreateFileMappingW (memoryapi.h)

Создает или открывает именованный или неименованный объект сопоставления файлов для указанного файла.

Сведения об указании узла NUMA для физической памяти см. в разделе CreateFileMappingNuma.

Синтаксис

HANDLE CreateFileMappingW(
  [in]           HANDLE                hFile,
  [in, optional] LPSECURITY_ATTRIBUTES lpFileMappingAttributes,
  [in]           DWORD                 flProtect,
  [in]           DWORD                 dwMaximumSizeHigh,
  [in]           DWORD                 dwMaximumSizeLow,
  [in, optional] LPCWSTR               lpName
);

Параметры

[in] hFile

Дескриптор файла, из которого создается объект сопоставления файлов.

Файл должен быть открыт с правами доступа, совместимыми с флагами защиты, указанными параметром flProtect . Это не обязательно, но рекомендуется открывать файлы, которые планируется сопоставить, для монопольного доступа. Дополнительные сведения см. в разделе Безопасность файлов и права доступа.

Если hFileINVALID_HANDLE_VALUE, вызывающий процесс должен также указать размер объекта сопоставления файлов в параметрах dwMaximumSizeHigh и dwMaximumSizeLow . В этом сценарии CreateFileMapping создает объект сопоставления файлов указанного размера, который поддерживается системным файлом подкачки, а не файлом в файловой системе.

[in, optional] lpFileMappingAttributes

Указатель на структуру SECURITY_ATTRIBUTES , которая определяет, может ли возвращаемый дескриптор наследоваться дочерними процессами. Член lpSecurityDescriptor структуры SECURITY_ATTRIBUTES задает дескриптор безопасности для нового объекта сопоставления файлов.

Если lpAttributes имеет значение NULL, дескриптор не может быть унаследован, а объект сопоставления файлов получает дескриптор безопасности по умолчанию. Списки управления доступом (ACL) в дескрипторе безопасности по умолчанию для объекта сопоставления файлов поступают из основного маркера или маркера олицетворения создателя. Дополнительные сведения см. в разделе Безопасность сопоставления файлов и права доступа.

[in] flProtect

Задает защиту страницы объекта сопоставления файлов. Все сопоставленные представления объекта должны быть совместимы с этой защитой.

Этот параметр может принимать одно из указанных ниже значений.

Приложение может указать один или несколько следующих атрибутов для объекта сопоставления файлов, объединяя их с одним из предыдущих значений защиты страниц.

[in] dwMaximumSizeHigh

DWORD высокого порядка максимального размера объекта сопоставления файлов.

[in] dwMaximumSizeLow

DWORD низкого порядка максимального размера объекта сопоставления файлов.

Если этот параметр и dwMaximumSizeHigh равны 0 (ноль), максимальный размер объекта сопоставления файлов будет равен текущему размеру файла, определяемого hFile .

Попытка сопоставить файл длиной 0 (ноль) завершается с ошибкой с кодом ERROR_FILE_INVALID. Приложения должны тестировать файлы длиной 0 (ноль) и отклонять эти файлы.

[in, optional] lpName

Имя объекта сопоставления файлов.

Если этот параметр соответствует имени существующего объекта сопоставления, функция запрашивает доступ к объекту с защитой, указанной flProtect .

Если этот параметр имеет значение NULL, объект сопоставления файлов создается без имени.

Если lpName соответствует имени существующего события, семафора, мьютекса, таймера ожидания или объекта задания, функция завершается ошибкой, а функция GetLastError возвращает ERROR_INVALID_HANDLE. Это происходит потому, что эти объекты используют одно и то же пространство имен.

Имя может иметь префикс "Global" или "Local" для явного создания объекта в глобальном пространстве имен или пространстве имен сеанса. Оставшаяся часть имени может содержать любой символ, кроме символа обратной косой черты (\). Для создания объекта сопоставления файлов в глобальном пространстве имен из сеанса, отличного от нулевого сеанса, требуется привилегия SeCreateGlobalPrivilege . Дополнительные сведения см. в разделе Пространства имен объектов ядра.

Быстрое переключение пользователей реализуется с помощью сеансов служб терминалов. Первый пользователь для входа использует сеанс 0 (ноль), следующий пользователь для входа использует сеанс 1 (один) и т. д. Имена объектов ядра должны соответствовать рекомендациям, изложенным для служб терминалов, чтобы приложения могли поддерживать нескольких пользователей.

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение является дескриптором для созданного объекта сопоставления файлов.

Если объект существует до вызова функции, функция возвращает дескриптор существующему объекту (с его текущим размером, а не указанным размером), а GetLastError возвращает ERROR_ALREADY_EXISTS.

Если функция завершается сбоем, возвращается значение NULL. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

После создания объекта сопоставления файлов размер файла не должен превышать размер объекта сопоставления файлов; Если это так, не все содержимое файла доступно для совместного использования.

Если приложение указывает размер объекта сопоставления файлов, который больше размера фактического именованного файла на диске и если защита страницы разрешает доступ на запись (то есть параметр flProtect указывает PAGE_READWRITE или PAGE_EXECUTE_READWRITE), файл на диске увеличивается в соответствии с указанным размером объекта сопоставления файлов. Если файл расширен, содержимое файла между старым и новым концами файла не гарантируется равным нулю; поведение определяется файловой системой. Если невозможно увеличить файл на диске, createFileMapping завершается ошибкой , и GetLastError возвращает ERROR_DISK_FULL.

Начальное содержимое страниц в объекте сопоставления файлов, поддерживаемом файлом подкачки операционной системы, равно 0 (ноль).

Дескриптор, возвращаемый CreateFileMapping , имеет полный доступ к новому объекту сопоставления файлов и может использоваться с любой функцией, требующей дескриптора для объекта сопоставления файлов.

Несколько процессов могут совместно использовать представление одного файла, используя один общий объект сопоставления файлов или создавая отдельные объекты сопоставления файлов, поддерживаемые одним и тем же файлом. Один объект сопоставления файлов может быть совместно использоваться несколькими процессами путем наследования дескриптора при создании процесса, дублирования дескриптора или открытия объекта сопоставления файлов по имени. Дополнительные сведения см. в разделе Функции CreateProcess, DuplicateHandle и OpenFileMapping .

Создание объекта сопоставления файлов фактически не сопоставляет представление с адресным пространством процесса. Функции MapViewOfFile и MapViewOfFileEx сопоставляют представление файла с адресным пространством процесса.

За одним важным исключением, представления файлов, производные от любого объекта сопоставления файлов, который поддерживается одним и тем же файлом, являются согласованными или идентичными в определенный момент времени. Когерентность гарантируется для представлений в рамках процесса и представлений, сопоставленных различными процессами.

Исключение связано с удаленными файлами. Несмотря на то, что CreateFileMapping работает с удаленными файлами, они не согласованы. Например, если два компьютера сопоставляют файл как доступный для записи и изменяют одну и ту же страницу, каждый компьютер видит только собственные записи на страницу. При обновлении данных на диске они не объединяются.

Сопоставленный файл и файл, к которому осуществляется доступ с помощью функций ввода-вывода (ReadFile и WriteFile), не обязательно являются согласованными.

Сопоставленные представления объекта сопоставления файлов поддерживают внутренние ссылки на объект, и объект сопоставления файлов не закрывается до тех пор, пока не будут освобождены все ссылки на него. Поэтому, чтобы полностью закрыть объект сопоставления файлов, приложение должно отменить сопоставление всех сопоставленных представлений объекта сопоставления файлов путем вызова UnmapViewOfFile и закрыть дескриптор объекта сопоставления файлов путем вызова CloseHandle. Эти функции можно вызывать в любом порядке.

При изменении файла с помощью сопоставленного представления метка времени последнего изменения может не обновляться автоматически. При необходимости вызывающий объект должен использовать SetFileTime для установки метки времени.

Для создания объекта сопоставления файлов в глобальном пространстве имен из сеанса, отличного от нулевого сеанса, требуется привилегия SeCreateGlobalPrivilege . Обратите внимание, что эта привилегия проверка ограничена созданием объектов сопоставления файлов и не применяется к открытию существующих. Например, если служба или система создает объект сопоставления файлов в глобальном пространстве имен, любой процесс, выполняющийся в любом сеансе, может получить доступ к объекту сопоставления файлов при условии, что вызывающий объект имеет необходимые права доступа.

Windows XP: Требование, описанное в предыдущем абзаце, появилось в Windows Server 2003 и Windows XP с пакетом обновления 2 (SP2)

Используйте структурированную обработку исключений для защиты любого кода, который записывает или считывает из представления файлов. Дополнительные сведения см. в статье Чтение и запись из представления файлов.

Чтобы получить сопоставление с разрешениями исполняемого файла, приложение должно вызвать CreateFileMapping с PAGE_EXECUTE_READWRITE или PAGE_EXECUTE_READ, а затем вызвать MapViewOfFile с FILE_MAP_EXECUTE | FILE_MAP_WRITE или FILE_MAP_EXECUTE | FILE_MAP_READ.

В Windows Server 2012 эта функция поддерживается следующими технологиями.

Примеры

Пример см. в разделах Создание именованной общей памяти или Создание сопоставления файлов с помощью больших страниц.

Требования

См. также

CloseHandle

CreateFileMappingNuma

Создание объекта сопоставления файлов

DuplicateHandle

Функции сопоставления файлов

MapViewOfFile

MapViewOfFileEx

Функции управления памятью

OpenFileMapping

ReadFile

SECURITY_ATTRIBUTES

UnmapViewOfFile

VirtualAlloc

WriteFile