共用方式為


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 參數所指定之保護旗標相容的訪問許可權開啟。 這並非必要專案,但建議您針對獨佔存取開啟您要對應的檔案。 如需詳細資訊,請參閱 檔案安全性和訪問許可權

如果 hFileINVALID_HANDLE_VALUE,呼叫進程也必須在 dwMaximumSizeHighdwMaximumSizeLow 參數中指定檔案對應物件的大小。 在此案例中, CreateFileMapping 會建立指定大小的檔案對應物件,該物件是由系統分頁檔案所支援,而不是由文件系統中的檔案所支援。

[in, optional] lpFileMappingAttributes

SECURITY_ATTRIBUTES 結構的指標,決定子進程是否可以繼承傳回的句柄。 SECURITY_ATTRIBUTES 結構的 lpSecurityDescriptor 成員會指定新檔案對應物件的安全性描述元。

如果 lpFileMappingAttributesNULL,則無法繼承句柄,而且檔案對應物件會取得預設的安全性描述元。 訪問控制清單 (ACL) 檔案對應對象的預設安全性描述項中,來自建立者的主要或模擬令牌。 如需詳細資訊,請參閱 檔案對應安全性和訪問許可權

[in] flProtect

指定檔案對應對象的頁面保護。 物件的所有對應檢視都必須與此保護相容。

此參數可以是下列其中一個值。

意義
PAGE_EXECUTE_READ
0x20
允許對檢視進行唯讀、寫入複製或執行存取。

hFile 參數指定的檔句柄必須使用GENERIC_READGENERIC_EXECUTE訪問許可權來建立。

Windows Server 2003 和 Windows XP: 這個值在 Windows XP SP2 和 Windows Server 2003 SP1 之前無法使用。

PAGE_EXECUTE_READWRITE
0x40
允許針對唯讀、寫入時複製、讀取/寫入或執行存取來對應檢視。

hFile 參數指定的檔句柄必須使用GENERIC_READGENERIC_WRITEGENERIC_EXECUTE訪問許可權來建立。

Windows Server 2003 和 Windows XP: 這個值在 Windows XP SP2 和 Windows Server 2003 SP1 之前無法使用。

PAGE_EXECUTE_WRITECOPY
0x80
允許對檢視進行唯讀、寫入複製或執行存取。 這個值相當於 PAGE_EXECUTE_READ

hFile 參數指定的檔句柄必須使用GENERIC_READGENERIC_EXECUTE訪問許可權來建立。

Windows Vista: 這個值在 Windows Vista SP1 之前無法使用。

Windows Server 2003 和 Windows XP: 不支援這個值。

PAGE_READONLY
0x02
允許對檢視進行唯讀或寫入複製存取的對應。 嘗試寫入特定區域會導致存取違規。

hFile 參數指定的檔句柄必須使用GENERIC_READ訪問許可權來建立。

PAGE_READWRITE
0x04
允許針對唯讀、寫入時複製或讀取/寫入存取權對應檢視。

hFile 參數指定的檔句柄必須使用GENERIC_READGENERIC_WRITE訪問許可權來建立。

PAGE_WRITECOPY
0x08
允許對檢視進行唯讀或寫入複製存取的對應。 這個值相當於 PAGE_READONLY

hFile 參數指定的檔句柄必須使用GENERIC_READ訪問許可權來建立。

 

應用程式可以藉由將它們與上述其中一個頁面保護值結合,為檔案對應物件指定下列一或多個屬性。

意義
SEC_COMMIT
0x8000000
如果檔案對應物件是由操作系統分頁檔案所支援, (hfile 參數 INVALID_HANDLE_VALUE) ,則指定當檔案的檢視對應到進程地址空間時,會認可整個頁面範圍,而不是保留。 系統必須有足夠的可認可頁面來保存整個對應。 否則, CreateFileMapping 會失敗。

此屬性對於可執行檔或數據檔所支援的檔案對應對象沒有任何作用, (hfile 參數是檔案) 句柄。

SEC_COMMIT 無法與 SEC_RESERVE結合。

如果未指定任何屬性,則會假設 SEC_COMMIT

SEC_IMAGE
0x1000000
指定 hFile 參數指定的檔案是可執行檔影像檔。

SEC_IMAGE屬性必須與頁面保護值結合,例如PAGE_READONLY。 不過,此頁面保護值不會影響可執行文件的檢視。 可執行檔本身會決定可執行文件檢視的頁面保護。

SEC_IMAGE沒有其他屬性有效。

SEC_IMAGE_NO_EXECUTE
0x11000000
指定 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 之前,不支援此值。

SEC_LARGE_PAGES
0x80000000
可讓大型頁面用於操作系統分頁檔案所支援的檔案對應物件, (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 之前,不支援此值。

Windowsxp: 不支援這個值。

SEC_NOCACHE
0x10000000
將所有頁面設定為不可快取。

應用程式不應該使用此屬性,除非裝置明確需要時。 使用與 SEC_NOCACHE 對應記憶體的內嵌函式可能會導致 EXCEPTION_ILLEGAL_INSTRUCTION 例外狀況。

SEC_NOCACHE 需要設定 SEC_RESERVESEC_COMMIT 屬性。

SEC_RESERVE
0x4000000
如果檔案對應物件是由操作系統分頁檔案所支援, (hfile 參數 INVALID_HANDLE_VALUE) ,則指定當檔案的檢視對應到進程地址空間時,整個頁面範圍會保留供進程稍後使用,而不是認可。

VirtualAlloc 函式的後續呼叫中,可以認可保留的頁面。 認可頁面之後,就無法使用 VirtualFree 函式釋放或取消認可這些頁面。

此屬性對於可執行檔映像檔或數據檔所支援的檔案對應對象沒有任何作用, (hfile 參數是檔案) 的句柄。

SEC_RESERVE 無法與 SEC_COMMIT結合。

SEC_WRITECOMBINE
0x40000000
將所有頁面設定為寫入合併。

應用程式不應該使用這個屬性,除非裝置明確需要時才使用此屬性。 使用與 SEC_WRITECOMBINE 對應記憶體的相互連結函式可能會導致 EXCEPTION_ILLEGAL_INSTRUCTION 例外狀況。

SEC_WRITECOMBINE 需要設定 SEC_RESERVESEC_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 符合現有事件、旗號、mutex、可等候的定時器或作業對象的名稱,則函式會失敗, 而且 GetLastError 函式會傳回 ERROR_INVALID_HANDLE。 這是因為這些對象共用相同的命名空間。

名稱可以有 「Global」 或 「Local」 前置詞,以在全域或會話命名空間中明確建立物件。 名稱的其餘部分可以包含任何字元,但反斜杠字元 (\) 除外。 從會話零以外的會話建立全域命名空間中的檔案對應物件需要 SeCreateGlobalPrivilege 許可權。 如需詳細資訊,請參閱 核心物件命名空間

使用終端機服務會話實作快速使用者切換。 第一個登入的使用者會使用會話 0 (零) ,下一個使用者登入會使用會話 1 (一個) 等等。 核心物件名稱必須遵循終端機服務概述的指導方針,讓應用程式可以支援多個使用者。

傳回值

如果函式成功,則傳回值是新建立之檔案對應物件的句柄。

如果物件存在於函式呼叫之前,函式會傳回現有物件的句柄 (其目前大小,而不是指定的大小) , 而 GetLastError 會傳回 ERROR_ALREADY_EXISTS

如果函式失敗,則傳回值為 NULL。 若要取得擴充的錯誤資訊,請呼叫 GetLastError

備註

建立檔案對應物件之後,檔案的大小不得超過檔案對應物件的大小;如果是,則並非所有檔案內容都可供共用。

如果應用程式指定大於磁碟上實際具名檔案大小的檔案對應物件大小,而且頁面保護允許寫入存取 (,flProtect 參數會指定 PAGE_READWRITEPAGE_EXECUTE_READWRITE) ,則磁碟上的檔案會增加以符合檔案對應物件的指定大小。 如果擴充檔案,則檔案的舊端與新檔案結尾之間的檔案內容不保證為零;行為是由檔案系統所定義。 如果磁碟上的檔案無法增加, CreateFileMapping 會失敗, 而且 GetLastError 會傳回 ERROR_DISK_FULL

操作系統分頁檔案所支援之檔案對應對象中頁面的初始內容為 0 (零) 。

CreateFileMapping 傳回的句柄具有新檔案對應物件的完整存取權,而且可以與需要檔案對應物件的句柄的任何函式搭配使用。

多個進程可以使用單一共享檔案對應物件,或建立相同檔案支援的個別檔案對應物件,來共用相同檔案的檢視。 透過在進程建立時繼承句柄、複製句柄,或依名稱開啟檔案對應物件,可以由多個進程共用單一檔案對應物件。 如需詳細資訊,請參閱 CreateProcessDuplicateHandleOpenFileMapping 函式

建立檔案對應對象實際上不會將檢視對應至進程位址空間。 MapViewOfFileMapViewOfFileEx 函式會將檔案的檢視對應至進程位址空間。

有一個重要例外狀況,衍生自相同檔案所支援之任何檔案對應對象的檔案檢視在特定時間是一致或相同的。 對於進程內的檢視,以及由不同進程對應的檢視,保證一致性。

例外狀況與遠端檔案相關。 雖然 CreateFileMapping 可與遠端檔案搭配使用,但不會保持一致。 例如,如果兩部計算機將檔案對應為可寫入,而且兩部計算機都會變更相同的頁面,則每部計算機只會看到自己的頁面寫入。 當數據在磁碟上更新時,它不會合併。

使用輸入和輸出 (I/) O 函式來存取的對應檔案和檔案, (ReadFileWriteFile) 不一定一致。

檔案對應對象的對應檢視會維護對象的內部參考,而且檔案對應對象在釋放所有參考之前不會關閉。 因此,若要完全關閉檔案對應物件,應用程式必須呼叫 UnmapViewOfFile 來取消對應檔案對應物件的所有對應檢視,並藉由呼叫 CloseHandle 關閉檔案對應物件句柄。 這些函式可以依任何順序呼叫。

透過對應檢視修改檔案時,可能不會自動更新上次修改時間戳。 如有需要,呼叫端應該使用 SetFileTime 來設定時間戳。

從會話零以外的會話建立全域命名空間中的檔案對應物件需要 SeCreateGlobalPrivilege 許可權。 請注意,此許可權檢查僅限於建立檔案對應物件,不適用於開啟現有的物件。 例如,如果服務或系統在全域命名空間中建立檔案對應物件,則任何會話中執行的任何進程都可以存取該檔案對應物件,前提是呼叫端具有必要的訪問許可權。

Windowsxp: 上一個段落中所述的需求是 Windows Server 2003 和 Windows XP 搭配 SP2 所介紹

使用結構化例外狀況處理來保護寫入或讀取檔案檢視的任何程序代碼。 如需詳細資訊,請參閱 從檔案檢視讀取和寫入

若要具有可執行許可權的對應,應用程式必須使用 PAGE_EXECUTE_READWRITEPAGE_EXECUTE_READ 呼叫 CreateFileMapping,然後使用 或FILE_MAP_EXECUTE | FILE_MAP_READ呼叫 MapViewOfFileFILE_MAP_EXECUTE | FILE_MAP_WRITE

在 Windows Server 2012 中,下列技術支援此函式。

技術 支援
伺服器消息塊 (SMB) 3.0 通訊協定 Yes
SMB 3.0 透明故障轉移 (TFO) Yes
具有向外延展檔案共用的SMB 3.0 (SO) Yes
叢集共用磁碟區文件系統 (CsvFS) Yes
彈性檔案系統 (ReFS)
 

範例

如需範例,請參閱 建立具名共用記憶體 或使用 大型頁面建立檔案對應

規格需求

需求
最低支援的用戶端 Windows XP [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 [僅限傳統型應用程式]
目標平台 Windows
標頭 winbase.h (包括 Windows.h、Memoryapi.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

CloseHandle

CreateFileMappingNuma

建立檔案對應物件

DuplicateHandle

檔案對應函式

MapViewOfFile

MapViewOfFileEx

記憶體管理功能

OpenFileMapping

ReadFile

SECURITY_ATTRIBUTES

UnmapViewOfFile

VirtualAlloc

WriteFile