UnmapViewOfFile

関数

マップされたファイルビューをプロセスのアドレス空間から解除する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL UnmapViewOfFile(
    MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress
);

パラメーター

名前	型	方向	説明
lpBaseAddress	MEMORY_MAPPED_VIEW_ADDRESS	in	アンマップするファイルのマップされたビューのベースアドレスへのポインター。この値は、 MapViewOfFile ファミリーのいずれかの関数を以前に呼び出したときに返された値と同一でなければなりません。

戻り値の型: BOOL

公式ドキュメント

ファイルのマップされたビューを、呼び出し元プロセスのアドレス空間からアンマップします。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

ファイルのマップされたビューをアンマップすると、プロセスのアドレス空間内でそのビューが占有していた範囲が無効になり、その範囲が他の割り当てに利用できるようになります。これにより、プロセスのワーキングセットに含まれていたアンマップ対象の各仮想ページのワーキングセットエントリが削除され、プロセスのワーキングセットサイズが減少します。また、対応する物理ページの共有カウントもデクリメントされます。

アンマップされたビュー内の変更されたページは、その共有カウントが 0 に達するまで、言い換えれば、それらのページを共有するすべてのプロセスのワーキングセットからアンマップまたはトリミングされるまで、ディスクに書き込まれません。さらにその時点でも、変更されたページは「遅延して」ディスクに書き込まれます。つまり、変更はメモリにキャッシュされ、後でディスクに書き込まれる場合があります。停電やシステムクラッシュが発生した場合のデータ損失リスクを最小限に抑えるため、アプリケーションは FlushViewOfFile 関数を使用して、変更されたページを明示的にフラッシュする必要があります。

アプリケーションがファイルマッピングオブジェクトの作成に使用したファイルハンドルを閉じても、システムは、ファイルの最後のビューがアンマップされるまで、対応するファイルを開いたままにします。最後のビューがまだアンマップされていないファイルは、共有制限なしで開いたまま保持されます。

Windows Server 2012 では、この関数は以下のテクノロジーでサポートされています。

テクノロジー	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 透過的フェールオーバー (TFO)	はい
SMB 3.0 とスケールアウトファイル共有 (SO)	はい
クラスター共有ボリュームファイルシステム (CsvFS)	はい
回復性ファイルシステム (ReFS)	はい

例

例については、 Creating a View Within a File を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL UnmapViewOfFile(
    MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool UnmapViewOfFile(
    MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress   // MEMORY_MAPPED_VIEW_ADDRESS
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnmapViewOfFile(
    lpBaseAddress As MEMORY_MAPPED_VIEW_ADDRESS   ' MEMORY_MAPPED_VIEW_ADDRESS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS
Declare PtrSafe Function UnmapViewOfFile Lib "kernel32" ( _
    ByVal lpBaseAddress As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

UnmapViewOfFile = ctypes.windll.kernel32.UnmapViewOfFile
UnmapViewOfFile.restype = wintypes.BOOL
UnmapViewOfFile.argtypes = [
    MEMORY_MAPPED_VIEW_ADDRESS,  # lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
UnmapViewOfFile = Fiddle::Function.new(
  lib['UnmapViewOfFile'],
  [
    Fiddle::TYPE_VOIDP,  # lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn UnmapViewOfFile(
        lpBaseAddress: MEMORY_MAPPED_VIEW_ADDRESS  // MEMORY_MAPPED_VIEW_ADDRESS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool UnmapViewOfFile(MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_UnmapViewOfFile' -Namespace Win32 -PassThru
# $api::UnmapViewOfFile(lpBaseAddress)

#uselib "KERNEL32.dll"
#func global UnmapViewOfFile "UnmapViewOfFile" sptr
; UnmapViewOfFile lpBaseAddress   ; 戻り値は stat
; lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global UnmapViewOfFile "UnmapViewOfFile" int
; res = UnmapViewOfFile(lpBaseAddress)
; lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。

; BOOL UnmapViewOfFile(MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress)
#uselib "KERNEL32.dll"
#cfunc global UnmapViewOfFile "UnmapViewOfFile" int
; res = UnmapViewOfFile(lpBaseAddress)
; lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procUnmapViewOfFile = kernel32.NewProc("UnmapViewOfFile")
)

// lpBaseAddress (MEMORY_MAPPED_VIEW_ADDRESS)
r1, _, err := procUnmapViewOfFile.Call(
	uintptr(lpBaseAddress),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function UnmapViewOfFile(
  lpBaseAddress: MEMORY_MAPPED_VIEW_ADDRESS   // MEMORY_MAPPED_VIEW_ADDRESS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'UnmapViewOfFile';

result := DllCall("KERNEL32\UnmapViewOfFile"
    , "Ptr", lpBaseAddress   ; MEMORY_MAPPED_VIEW_ADDRESS
    , "Int")   ; return: BOOL

●UnmapViewOfFile(lpBaseAddress) = DLL("KERNEL32.dll", "bool UnmapViewOfFile(void*)")
# 呼び出し: UnmapViewOfFile(lpBaseAddress)
# lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn UnmapViewOfFile(
    lpBaseAddress: MEMORY_MAPPED_VIEW_ADDRESS // MEMORY_MAPPED_VIEW_ADDRESS
) callconv(std.os.windows.WINAPI) i32;

proc UnmapViewOfFile(
    lpBaseAddress: MEMORY_MAPPED_VIEW_ADDRESS  # MEMORY_MAPPED_VIEW_ADDRESS
): int32 {.importc: "UnmapViewOfFile", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int UnmapViewOfFile(
    MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress   // MEMORY_MAPPED_VIEW_ADDRESS
);

ccall((:UnmapViewOfFile, "KERNEL32.dll"), stdcall, Int32,
      (MEMORY_MAPPED_VIEW_ADDRESS,),
      lpBaseAddress)
# lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> MEMORY_MAPPED_VIEW_ADDRESS
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t UnmapViewOfFile(
    MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.UnmapViewOfFile(lpBaseAddress)
-- lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const UnmapViewOfFile = lib.func('__stdcall', 'UnmapViewOfFile', 'int32_t', ['MEMORY_MAPPED_VIEW_ADDRESS']);
// UnmapViewOfFile(lpBaseAddress)
// lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> 'MEMORY_MAPPED_VIEW_ADDRESS'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  UnmapViewOfFile: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.UnmapViewOfFile(lpBaseAddress)
// lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t UnmapViewOfFile(
    MEMORY_MAPPED_VIEW_ADDRESS lpBaseAddress);
C, "KERNEL32.dll");
// $ffi->UnmapViewOfFile(lpBaseAddress);
// lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。

import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean UnmapViewOfFile(
        MEMORY_MAPPED_VIEW_ADDRESS /* extends Structure (by value) */ lpBaseAddress   // MEMORY_MAPPED_VIEW_ADDRESS
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun UnmapViewOfFile = UnmapViewOfFile(
    lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS   # MEMORY_MAPPED_VIEW_ADDRESS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UnmapViewOfFileNative = Int32 Function(MEMORY_MAPPED_VIEW_ADDRESS);
typedef UnmapViewOfFileDart = int Function(int);
final UnmapViewOfFile = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<UnmapViewOfFileNative, UnmapViewOfFileDart>('UnmapViewOfFile');
// lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> MEMORY_MAPPED_VIEW_ADDRESS
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function UnmapViewOfFile(
  lpBaseAddress: MEMORY_MAPPED_VIEW_ADDRESS   // MEMORY_MAPPED_VIEW_ADDRESS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'UnmapViewOfFile';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UnmapViewOfFile"
  c_UnmapViewOfFile :: MEMORY_MAPPED_VIEW_ADDRESS -> IO CInt
-- lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> MEMORY_MAPPED_VIEW_ADDRESS
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。

open Ctypes
open Foreign

let unmapviewoffile =
  foreign "UnmapViewOfFile"
    (MEMORY_MAPPED_VIEW_ADDRESS @-> returning int32_t)
(* lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> MEMORY_MAPPED_VIEW_ADDRESS *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("UnmapViewOfFile" unmap-view-of-file :convention :stdcall) :int32
  (lp-base-address (:struct memory-mapped-view-address)))   ; MEMORY_MAPPED_VIEW_ADDRESS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $UnmapViewOfFile = Win32::API::More->new('KERNEL32',
    'BOOL UnmapViewOfFile(LPVOID lpBaseAddress)');
# my $ret = $UnmapViewOfFile->Call($lpBaseAddress);
# lpBaseAddress : MEMORY_MAPPED_VIEW_ADDRESS -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。