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

OpenFileMappingA

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE OpenFileMappingA(
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    LPCSTR lpName
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

関数が成功すると、戻り値は指定されたファイルマッピングオブジェクトへの開かれたハンドルになります。

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

解説(Remarks)

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

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

不要になった時点で、呼び出し元は CloseHandle を呼び出して、OpenFileMapping が返したハンドルを解放する必要があります。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 トランスペアレントフェールオーバー (TFO) はい
スケールアウトファイル共有 (SO) を使用した SMB 3.0 はい
クラスター共有ボリュームファイルシステム (CsvFS) はい
回復性ファイルシステム (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  (ANSI / -A)
#include <windows.h>

HANDLE OpenFileMappingA(
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    LPCSTR lpName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenFileMappingA(
    uint dwDesiredAccess,   // DWORD
    bool bInheritHandle,   // BOOL
    [MarshalAs(UnmanagedType.LPStr)] string lpName   // LPCSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenFileMappingA(
    dwDesiredAccess As UInteger,   ' DWORD
    bInheritHandle As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPStr)> lpName As String   ' LPCSTR
) As IntPtr
End Function
' dwDesiredAccess : DWORD
' bInheritHandle : BOOL
' lpName : LPCSTR
Declare PtrSafe Function OpenFileMappingA Lib "kernel32" ( _
    ByVal dwDesiredAccess As Long, _
    ByVal bInheritHandle As Long, _
    ByVal lpName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOpenFileMappingA = kernel32.NewProc("OpenFileMappingA")
)

// dwDesiredAccess (DWORD), bInheritHandle (BOOL), lpName (LPCSTR)
r1, _, err := procOpenFileMappingA.Call(
	uintptr(dwDesiredAccess),
	uintptr(bInheritHandle),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function OpenFileMappingA(
  dwDesiredAccess: DWORD;   // DWORD
  bInheritHandle: BOOL;   // BOOL
  lpName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenFileMappingA';
result := DllCall("KERNEL32\OpenFileMappingA"
    , "UInt", dwDesiredAccess   ; DWORD
    , "Int", bInheritHandle   ; BOOL
    , "AStr", lpName   ; LPCSTR
    , "Ptr")   ; return: HANDLE
●OpenFileMappingA(dwDesiredAccess, bInheritHandle, lpName) = DLL("KERNEL32.dll", "void* OpenFileMappingA(dword, bool, char*)")
# 呼び出し: OpenFileMappingA(dwDesiredAccess, bInheritHandle, lpName)
# dwDesiredAccess : DWORD -> "dword"
# bInheritHandle : BOOL -> "bool"
# lpName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

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

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

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

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

関連項目

文字セット違い