CreateFileMappingA 関数 (winbase.h)
指定したファイルの名前付きまたは名前のないファイル マッピング オブジェクトを作成または開きます。
物理メモリの NUMA ノードを指定するには、「 CreateFileMappingNuma」を参照してください。
構文
HANDLE CreateFileMappingA(
[in] HANDLE hFile,
[in, optional] LPSECURITY_ATTRIBUTES lpFileMappingAttributes,
[in] DWORD flProtect,
[in] DWORD dwMaximumSizeHigh,
[in] DWORD dwMaximumSizeLow,
[in, optional] LPCSTR lpName
);
パラメーター
[in] hFile
ファイル マッピング オブジェクトの作成元となるファイルへのハンドル。
flProtect パラメーターが指定する保護フラグと互換性のあるアクセス権を持つファイルを開く必要があります。 必須ではありませんが、マップする予定のファイルを排他的アクセス用に開くことをお勧めします。 詳細については、「 ファイル のセキュリティとアクセス権」を参照してください。
hFile がINVALID_HANDLE_VALUEの場合、呼び出し元プロセスでは、dwMaximumSizeHigh パラメーターと dwMaximumSizeLow パラメーターでファイル マッピング オブジェクトのサイズも指定する必要があります。 このシナリオでは、 CreateFileMapping によって、指定したサイズのファイル マッピング オブジェクトが作成されます。このオブジェクトは、ファイル システム内のファイルではなく、システム ページング ファイルによってサポートされます。
[in, optional] lpFileMappingAttributes
返された ハンドルを子 プロセスによって継承できるかどうかを決定するSECURITY_ATTRIBUTES構造体へのポインター。 SECURITY_ATTRIBUTES構造体の lpSecurityDescriptor メンバーは、新しいファイル マッピング オブジェクトのセキュリティ記述子を指定します。
lpFileMappingAttributes が NULL の場合、ハンドルを継承できず、ファイル マッピング オブジェクトは既定のセキュリティ記述子を取得します。 ファイル マッピング オブジェクトの既定のセキュリティ記述子のアクセス制御リスト (ACL) は、作成者のプライマリ トークンまたは偽装トークンから取得されます。 詳細については、「 ファイル マッピングのセキュリティとアクセス権」を参照してください。
[in] flProtect
ファイル マッピング オブジェクトのページ保護を指定します。 オブジェクトのすべてのマップされたビューは、この保護と互換性がある必要があります。
このパラメーターには、次の値のいずれかを指定できます。
アプリケーションは、ファイル マッピング オブジェクトに対して次の属性の 1 つ以上を指定できます。これらの属性を、上記のページ保護値のいずれかと組み合わせて使用できます。
| 値 | 意味 |
|---|---|
|
ファイル マッピング オブジェクトがオペレーティング システムのページング ファイルによってサポートされている場合 ( hfile パラメーターが INVALID_HANDLE_VALUE)、ファイルのビューがプロセス アドレス空間にマップされるときに、ページの範囲全体が予約ではなくコミットされることを指定します。 システムには、マッピング全体を保持するのに十分なコミット可能なページが必要です。 それ以外の場合、 CreateFileMapping は失敗します。
この属性は、実行可能イメージ ファイルまたはデータ ファイルによってサポートされるファイル マッピング オブジェクトには影響しません ( hfile パラメーターはファイルへのハンドルです)。 SEC_COMMIT を SEC_RESERVEと組み合わせることはできません。 属性が指定されていない場合は、 SEC_COMMIT が想定されます。 |
|
hFile パラメーターが指定するファイルが実行可能イメージ ファイルであることを指定します。
SEC_IMAGE属性は、PAGE_READONLYなどのページ保護値と組み合わせる必要があります。 ただし、このページ保護値は、実行可能イメージ ファイルのビューには影響しません。 実行可能イメージ ファイルのビューのページ保護は、実行可能ファイル自体によって決まります。 その他の属性は 、SEC_IMAGEで有効ではありません。 |
|
hFile パラメーターが指定するファイルが実行可能イメージ ファイルであり、実行されず、読み込まれたイメージ ファイルに強制整合性チェックが実行されないことを指定します。
さらに、 SEC_IMAGE_NO_EXECUTE 属性を使用して作成されたファイル マッピング オブジェクトのビューをマッピングしても、 PsSetLoadImageNotifyRoutine カーネル API を使用して登録されたドライバー コールバックは呼び出されません。
SEC_IMAGE_NO_EXECUTE属性は、PAGE_READONLY ページ保護の値と組み合わせる必要があります。 その他の属性は 、SEC_IMAGE_NO_EXECUTEで有効ではありません。 Windows Server 2008 R2、Windows 7、Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は、Windows Server 2012およびWindows 8前にはサポートされていません。 |
|
オペレーティング システムのページング ファイルによってサポートされるファイル マッピング オブジェクトに大きなページを使用できるようにします ( hfile パラメーターは INVALID_HANDLE_VALUE)。 この属性は、実行可能イメージ ファイルまたはデータ ファイルによってサポートされるファイル マッピング オブジェクトではサポートされていません ( hFile パラメーターは実行可能イメージまたはデータ ファイルへのハンドルです)。
ファイル マッピング オブジェクトの最大サイズは、 GetLargePageMinimum 関数によって返される大きなページの最小サイズの倍数である必要があります。 そうでない場合、 CreateFileMapping は失敗します。 SEC_LARGE_PAGESを使用して作成されたファイル マッピング オブジェクトのビューをマッピングする場合、ベース アドレスとビュー サイズも、最小大きなページ サイズの倍数である必要があります。 SEC_LARGE_PAGES は、呼び出し元のトークンで SeLockMemoryPrivilege 特権を有効にする必要があります。 SEC_LARGE_PAGESを指定する場合は、SEC_COMMITも指定する必要があります。 Windows Server 2003: この値は、Windows Server 2003 SP1 までサポートされていません。 Windows XP: この値はサポートされていません。 |
|
すべてのページをキャッシュ不可に設定します。
アプリケーションでは、デバイスに明示的に必要な場合を除き、この属性を使用しないでください。 SEC_NOCACHEにマップされたメモリでインターロックされた関数 を 使用すると、 EXCEPTION_ILLEGAL_INSTRUCTION 例外が発生する可能性があります。 SEC_NOCACHE では、 SEC_RESERVE または SEC_COMMIT 属性を設定する必要があります。 |
|
ファイル マッピング オブジェクトがオペレーティング システムのページング ファイルによってサポートされている場合 ( hfile パラメーターが INVALID_HANDLE_VALUE)、ファイルのビューがプロセス アドレス空間にマップされるときに、ページの範囲全体がコミットされるのではなく、後でプロセスで使用するために予約されることを指定します。
予約済みページは、 VirtualAlloc 関数の後続の呼び出しでコミットできます。 ページをコミットした後は、 VirtualFree 関数を使用してページを解放したり、コミットを解除したりすることはできません。 この属性は、実行可能イメージ ファイルまたはデータ ファイルによってサポートされるファイル マッピング オブジェクトには影響しません ( hfile パラメーターはファイルへのハンドルです)。 SEC_RESERVE を SEC_COMMITと組み合わせることはできません。 |
|
すべてのページを書き込み結合するように設定します。
アプリケーションでは、デバイスに明示的に必要な場合を除き、この属性を使用しないでください。 SEC_WRITECOMBINEにマップされたメモリでインターロックされた関数 を 使用すると、 EXCEPTION_ILLEGAL_INSTRUCTION 例外が発生する可能性があります。 SEC_WRITECOMBINE には、 SEC_RESERVE または SEC_COMMIT 属性を設定する必要があります。 Windows Server 2003 および Windows XP: このフラグは、Windows Vista までサポートされていません。 |
[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" プレフィックスを付けることができます。 名前の残りの部分には、円記号 (\) を除く任意の文字を含めることができます。 セッション 0 以外のセッションからグローバル名前空間にファイル マッピング オブジェクトを作成するには、 SeCreateGlobalPrivilege 特権が必要です。 詳細については、「 カーネル オブジェクトの名前空間」を参照してください。
高速ユーザー切り替えは、ターミナル サービス セッションを使用して実装されます。 ログオンする最初のユーザーはセッション 0 (ゼロ) を使用し、次にログオンするユーザーはセッション 1 (1) を使用します。 カーネル オブジェクト名は、アプリケーションが複数のユーザーをサポートできるように、ターミナル サービスに関して概説されているガイドラインに従う必要があります。
戻り値
関数が成功した場合、戻り値は新しく作成されたファイル マッピング オブジェクトへのハンドルです。
関数呼び出しの前に オブジェクトが存在する場合、関数は既存のオブジェクト (指定したサイズではなく現在のサイズ) へのハンドルを返し、GetLastError はERROR_ALREADY_EXISTSを返します。
関数が失敗した場合は、返される値は NULL です。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
ファイル マッピング オブジェクトが作成された後、ファイルのサイズがファイル マッピング オブジェクトのサイズを超えてはなりません。存在する場合は、すべてのファイル コンテンツを共有できるわけではありません。
アプリケーションで、ディスク上の実際の名前付きファイルのサイズよりも大きいファイル マッピング オブジェクトのサイズを指定し、ページ保護で書き込みアクセスが許可されている場合 (つまり、 flProtect パラメーターで PAGE_READWRITE または PAGE_EXECUTE_READWRITEが指定されている場合)、ディスク上のファイルは、ファイル マッピング オブジェクトの指定されたサイズと一致するように増やされます。 ファイルが拡張されている場合、ファイルの古い末尾とファイルの新しい末尾の間のファイルの内容が 0 であるとは限りません。動作はファイル システムによって定義されます。 ディスク上のファイルを増やすことができない場合、CreateFileMapping は失敗し、GetLastError はERROR_DISK_FULLを返します。
オペレーティング システムのページング ファイルによってサポートされるファイル マッピング オブジェクト内のページの初期コンテンツは 0 (ゼロ) です。
CreateFileMapping が返すハンドルは、新しいファイル マッピング オブジェクトへのフル アクセス権を持ち、ファイル マッピング オブジェクトへのハンドルを必要とする任意の関数で使用できます。
複数のプロセスで同じファイルのビューを共有するには、1 つの共有ファイル マッピング オブジェクトを使用するか、同じファイルでバックアップされた個別のファイル マッピング オブジェクトを作成します。 プロセスの作成時にハンドルを継承するか、ハンドルを複製するか、ファイル マッピング オブジェクトを名前で開くことで、1 つのファイル マッピング オブジェクトを複数のプロセスで共有できます。 詳細については、 CreateProcess、 DuplicateHandle 、 OpenFileMapping 関数に関するページを参照してください。
ファイル マッピング オブジェクトを作成しても、実際にはビューはプロセス アドレス空間にマップされません。 MapViewOfFile 関数と MapViewOfFileEx 関数は、ファイルのビューをプロセス アドレス空間にマップします。
1 つの重要な例外では、同じファイルによってサポートされるファイル マッピング オブジェクトから派生したファイル ビューは、特定の時点で一貫しているか同一です。 一貫性は、プロセス内のビューと、異なるプロセスによってマップされるビューに対して保証されます。
例外はリモート ファイルに関連しています。 CreateFileMapping はリモート ファイルで動作しますが、一貫性を保つものではありません。 たとえば、2 台のコンピューターがファイルを書き込み可能としてマップし、両方とも同じページを変更した場合、各コンピューターにはページへの独自の書き込みのみが表示されます。 ディスク上のデータが更新されると、マージされません。
入出力 (I/O) 関数 (ReadFile および WriteFile) を使用してアクセスされるマップされたファイルとファイルは、必ずしも一貫性があるとは限りません。
ファイル マッピング オブジェクトのマップされたビューは、オブジェクトへの内部参照を保持し、ファイル マッピング オブジェクトは、そのオブジェクトへのすべての参照が解放されるまで閉じません。 したがって、ファイル マッピング オブジェクトを完全に閉じるには、 UnmapViewOfFile を呼び出してファイル マッピング オブジェクトのすべてのマップされたビューをマップ解除し、 CloseHandle を呼び出してファイル マッピング オブジェクト ハンドルを閉じる必要があります。 これらの関数は、任意の順序で呼び出すことができます。
マップされたビューを使用してファイルを変更する場合、最後の変更タイムスタンプが自動的に更新されない場合があります。 必要に応じて、呼び出し元は SetFileTime を使用してタイムスタンプを設定する必要があります。
セッション 0 以外のセッションからグローバル名前空間にファイル マッピング オブジェクトを作成するには、 SeCreateGlobalPrivilege 特権が必要です。 この特権チェックは、ファイル マッピング オブジェクトの作成に限定され、既存のオブジェクトを開く場合には適用されないことに注意してください。 たとえば、サービスまたはシステムがグローバル名前空間にファイル マッピング オブジェクトを作成する場合、呼び出し元が必要なアクセス権を持っている場合、任意のセッションで実行されているプロセスは、そのファイル マッピング オブジェクトにアクセスできます。
Windows XP: 前の段落で説明した要件は、Windows Server 2003 と Windows XP SP2 で導入されました
構造化例外処理を使用して、ファイル ビューへの書き込みまたはファイル ビューからの読み取りを行うコードを保護します。 詳細については、「 ファイル ビューからの読み取りと書き込み」を参照してください。
実行可能なアクセス許可を持つマッピングを作成するには、アプリケーションで CreateFileMapping を PAGE_EXECUTE_READWRITE または PAGE_EXECUTE_READで呼び出し、 または FILE_MAP_EXECUTE | FILE_MAP_READを使用して MapViewOfFileFILE_MAP_EXECUTE | FILE_MAP_WRITE を呼び出す必要があります。
Windows Server 2012では、この関数は次のテクノロジでサポートされています。
| テクノロジ | サポートされています |
|---|---|
| サーバー メッセージ ブロック (SMB) 3.0 プロトコル | はい |
| SMB 3.0 Transparent Failover (TFO) | はい |
| スケールアウト ファイル共有 (SO) を使う SMB 3.0 | はい |
| クラスターの共有ボリューム ファイル システム (CsvFS) | はい |
| Resilient File System (ReFS) | はい |
例
例については、「 名前付き共有メモリの作成 」または「 大きなページを使用したファイル マッピングの作成」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | winbase.h (Windows.h、Memoryapi.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |
関連項目
ファイル マッピング関数