Win32 API 日本語リファレンス
ホームSystem.Memory › OpenFileMappingW

OpenFileMappingW

関数
名前付きファイルマッピングオブジェクトを開く(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE OpenFileMappingW(
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    LPCWSTR lpName
);

パラメーター

名前方向説明
dwDesiredAccessDWORDinファイルマッピングオブジェクトに対するアクセス権です。このアクセス権は、対象のファイルマッピングオブジェクトに設定されているセキュリティ記述子と照合されます。指定可能な値の一覧については、 File Mapping Security and Access Rights を参照してください。
bInheritHandleBOOLinこのパラメーターが TRUE の場合、 CreateProcess 関数によって作成されたプロセスはこのハンドルを継承できます。 それ以外の場合、ハンドルは継承されません。
lpNameLPCWSTRin開くファイルマッピングオブジェクトの名前です。この名前を持つファイルマッピングオブジェクトへの開かれたハンドルが存在し、かつマッピングオブジェクトのセキュリティ記述子が dwDesiredAccess パラメーターと矛盾しない場合、オープン操作は成功します。名前には "Global" または "Local" のプレフィックスを付けて、グローバル名前空間またはセッション名前空間内のオブジェクトを明示的に開くことができます。名前の残りの部分には、バックスラッシュ文字 (\) を除く任意の文字を含めることができます。詳細については、 Kernel Object Namespaces を参照してください。ファストユーザー切り替えは、ターミナルサービスのセッションを使用して実装されています。最初にログオンしたユーザーはセッション 0 を使用し、次にログオンしたユーザーはセッション 1 を使用し、以降同様に続きます。アプリケーションが複数のユーザーをサポートできるよう、カーネルオブジェクト名はターミナルサービス向けに示されたガイドラインに従う必要があります。

戻り値の型: HANDLE

公式ドキュメント

名前付きのファイルマッピングオブジェクトを開きます。(OpenFileMappingW)

戻り値

関数が成功した場合、戻り値は指定したファイルマッピングオブジェクトへの開かれたハンドルです。

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

解説(Remarks)

OpenFileMapping が返すハンドルは、ファイルマッピングオブジェクトへのハンドルを必要とする任意の関数で使用できます。

マップされたビューを通じてファイルを変更する場合、最終更新タイムスタンプは自動的には更新されないことがあります。 必要であれば、呼び出し元は SetFileTime を使用してタイムスタンプを設定してください。

ハンドルが不要になったら、呼び出し元は CloseHandle を呼び出して、 OpenFileMapping が返したハンドルを解放してください。

Windows Server 2012 では、この関数は次の技術でサポートされています。

技術 サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい

例については、 Creating Named Shared Memory を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE OpenFileMappingW(
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    LPCWSTR lpName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenFileMappingW(
    uint dwDesiredAccess,   // DWORD
    bool bInheritHandle,   // BOOL
    [MarshalAs(UnmanagedType.LPWStr)] string lpName   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenFileMappingW(
    dwDesiredAccess As UInteger,   ' DWORD
    bInheritHandle As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String   ' LPCWSTR
) As IntPtr
End Function
' dwDesiredAccess : DWORD
' bInheritHandle : BOOL
' lpName : LPCWSTR
Declare PtrSafe Function OpenFileMappingW Lib "kernel32" ( _
    ByVal dwDesiredAccess As Long, _
    ByVal bInheritHandle As Long, _
    ByVal lpName As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenFileMappingW = ctypes.windll.kernel32.OpenFileMappingW
OpenFileMappingW.restype = ctypes.c_void_p
OpenFileMappingW.argtypes = [
    wintypes.DWORD,  # dwDesiredAccess : DWORD
    wintypes.BOOL,  # bInheritHandle : BOOL
    wintypes.LPCWSTR,  # lpName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
OpenFileMappingW = Fiddle::Function.new(
  lib['OpenFileMappingW'],
  [
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
    Fiddle::TYPE_INT,  # bInheritHandle : BOOL
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn OpenFileMappingW(
        dwDesiredAccess: u32,  // DWORD
        bInheritHandle: i32,  // BOOL
        lpName: *const u16  // LPCWSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr OpenFileMappingW(uint dwDesiredAccess, bool bInheritHandle, [MarshalAs(UnmanagedType.LPWStr)] string lpName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenFileMappingW' -Namespace Win32 -PassThru
# $api::OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName)
#uselib "KERNEL32.dll"
#func global OpenFileMappingW "OpenFileMappingW" wptr, wptr, wptr
; OpenFileMappingW dwDesiredAccess, bInheritHandle, lpName   ; 戻り値は stat
; dwDesiredAccess : DWORD -> "wptr"
; bInheritHandle : BOOL -> "wptr"
; lpName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global OpenFileMappingW "OpenFileMappingW" int, int, wstr
; res = OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName)
; dwDesiredAccess : DWORD -> "int"
; bInheritHandle : BOOL -> "int"
; lpName : LPCWSTR -> "wstr"
; HANDLE OpenFileMappingW(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCWSTR lpName)
#uselib "KERNEL32.dll"
#cfunc global OpenFileMappingW "OpenFileMappingW" int, int, wstr
; res = OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName)
; dwDesiredAccess : DWORD -> "int"
; bInheritHandle : BOOL -> "int"
; lpName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOpenFileMappingW = kernel32.NewProc("OpenFileMappingW")
)

// dwDesiredAccess (DWORD), bInheritHandle (BOOL), lpName (LPCWSTR)
r1, _, err := procOpenFileMappingW.Call(
	uintptr(dwDesiredAccess),
	uintptr(bInheritHandle),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function OpenFileMappingW(
  dwDesiredAccess: DWORD;   // DWORD
  bInheritHandle: BOOL;   // BOOL
  lpName: PWideChar   // LPCWSTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenFileMappingW';
result := DllCall("KERNEL32\OpenFileMappingW"
    , "UInt", dwDesiredAccess   ; DWORD
    , "Int", bInheritHandle   ; BOOL
    , "WStr", lpName   ; LPCWSTR
    , "Ptr")   ; return: HANDLE
●OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName) = DLL("KERNEL32.dll", "void* OpenFileMappingW(dword, bool, char*)")
# 呼び出し: OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName)
# dwDesiredAccess : DWORD -> "dword"
# bInheritHandle : BOOL -> "bool"
# lpName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn OpenFileMappingW(
    dwDesiredAccess: u32, // DWORD
    bInheritHandle: i32, // BOOL
    lpName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc OpenFileMappingW(
    dwDesiredAccess: uint32,  # DWORD
    bInheritHandle: int32,  # BOOL
    lpName: WideCString  # LPCWSTR
): pointer {.importc: "OpenFileMappingW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
void* OpenFileMappingW(
    uint dwDesiredAccess,   // DWORD
    int bInheritHandle,   // BOOL
    const(wchar)* lpName   // LPCWSTR
);
ccall((:OpenFileMappingW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (UInt32, Int32, Cwstring),
      dwDesiredAccess, bInheritHandle, lpName)
# dwDesiredAccess : DWORD -> UInt32
# bInheritHandle : BOOL -> Int32
# lpName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* OpenFileMappingW(
    uint32_t dwDesiredAccess,
    int32_t bInheritHandle,
    const uint16_t* lpName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName)
-- dwDesiredAccess : DWORD
-- bInheritHandle : BOOL
-- lpName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const OpenFileMappingW = lib.func('__stdcall', 'OpenFileMappingW', 'void *', ['uint32_t', 'int32_t', 'str16']);
// OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName)
// dwDesiredAccess : DWORD -> 'uint32_t'
// bInheritHandle : BOOL -> 'int32_t'
// lpName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  OpenFileMappingW: { parameters: ["u32", "i32", "buffer"], result: "pointer" },
});
// lib.symbols.OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName)
// dwDesiredAccess : DWORD -> "u32"
// bInheritHandle : BOOL -> "i32"
// lpName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* OpenFileMappingW(
    uint32_t dwDesiredAccess,
    int32_t bInheritHandle,
    const uint16_t* lpName);
C, "KERNEL32.dll");
// $ffi->OpenFileMappingW(dwDesiredAccess, bInheritHandle, lpName);
// dwDesiredAccess : DWORD
// bInheritHandle : BOOL
// lpName : LPCWSTR
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    Pointer OpenFileMappingW(
        int dwDesiredAccess,   // DWORD
        boolean bInheritHandle,   // BOOL
        WString lpName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun OpenFileMappingW = OpenFileMappingW(
    dwDesiredAccess : UInt32,   # DWORD
    bInheritHandle : Int32,   # BOOL
    lpName : UInt16*   # LPCWSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OpenFileMappingWNative = Pointer<Void> Function(Uint32, Int32, Pointer<Utf16>);
typedef OpenFileMappingWDart = Pointer<Void> Function(int, int, Pointer<Utf16>);
final OpenFileMappingW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<OpenFileMappingWNative, OpenFileMappingWDart>('OpenFileMappingW');
// dwDesiredAccess : DWORD -> Uint32
// bInheritHandle : BOOL -> Int32
// lpName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenFileMappingW(
  dwDesiredAccess: DWORD;   // DWORD
  bInheritHandle: BOOL;   // BOOL
  lpName: PWideChar   // LPCWSTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenFileMappingW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenFileMappingW"
  c_OpenFileMappingW :: Word32 -> CInt -> CWString -> IO (Ptr ())
-- dwDesiredAccess : DWORD -> Word32
-- bInheritHandle : BOOL -> CInt
-- lpName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openfilemappingw =
  foreign "OpenFileMappingW"
    (uint32_t @-> int32_t @-> (ptr uint16_t) @-> returning (ptr void))
(* dwDesiredAccess : DWORD -> uint32_t *)
(* bInheritHandle : BOOL -> int32_t *)
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("OpenFileMappingW" open-file-mapping-w :convention :stdcall) :pointer
  (dw-desired-access :uint32)   ; DWORD
  (b-inherit-handle :int32)   ; BOOL
  (lp-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenFileMappingW = Win32::API::More->new('KERNEL32',
    'HANDLE OpenFileMappingW(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCWSTR lpName)');
# my $ret = $OpenFileMappingW->Call($dwDesiredAccess, $bInheritHandle, $lpName);
# dwDesiredAccess : DWORD -> DWORD
# bInheritHandle : BOOL -> BOOL
# lpName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目