OpenFile
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
INT OpenFile(
LPCSTR lpFileName,
OFSTRUCT* lpReOpenBuff,
DWORD uStyle
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| lpFileName | LPCSTR | in | ファイルの名前です。 この文字列は 8 ビットの Windows 文字セットに含まれる文字で構成する必要があります。 OpenFile 関数は Unicode のファイル名や、名前付きパイプのオープンをサポートしません。 | ||||||||||||||||||||||||||||||||||
| lpReOpenBuff | OFSTRUCT* | inout | ファイルが最初に開かれたときに、そのファイルに関する情報を受け取る OFSTRUCT 構造体へのポインターです。 この構造体は、開いているファイルを参照するために、後続の OpenFile 関数の呼び出しで使用できます。 OFSTRUCT 構造体には、長さが OFS_MAXPATHNAME 文字(128 文字)に制限されたパス文字列メンバーが含まれます。 このため、OpenFile 関数を使用してパス長が 128 文字を超えるファイルを開くことはできません。 CreateFile 関数には、このようなパス長の制限はありません。 | ||||||||||||||||||||||||||||||||||
| uStyle | DWORD | in | 実行する操作です。 このパラメーターには、次の値を 1 つ以上指定できます。
|
戻り値の型: INT
公式ドキュメント
ファイルの作成、オープン、再オープン、または削除を行います。
戻り値
関数が成功した場合、戻り値はファイル I/O を実行する際に使用するファイル ハンドルを示します。ファイルを閉じるには、このハンドルを使用して CloseHandle 関数を呼び出してください。
関数が失敗した場合、戻り値は HFILE_ERROR です。拡張エラー情報を取得するには、GetLastError を呼び出してください。
解説(Remarks)
lpFileName パラメーターにファイル名と拡張子のみを指定した場合、この関数は次のディレクトリを以下に示す順序で検索し、一致するファイルを探します。
- アプリケーションが読み込まれたディレクトリ。
- カレント ディレクトリ。
-
Windows システム ディレクトリ。
このディレクトリのパスを取得するには、GetSystemDirectory 関数を使用してください。
-
16 ビット Windows システム ディレクトリ。
このディレクトリのパスを取得する関数はありませんが、検索の対象になります。
-
Windows ディレクトリ。
このディレクトリのパスを取得するには、GetWindowsDirectory 関数を使用してください。
- PATH 環境変数に列挙されているディレクトリ。
OpenFile 関数は、16 ビット Windows の OpenFile 関数がサポートしていた OF_SEARCH フラグをサポートしません。 OF_SEARCH フラグは、ファイル名にフル パスが含まれている場合でも、一致するファイルを検索するようシステムに指示するものです。ファイルを検索するには、SearchPath 関数を使用してください。
uStyle パラメーターの値が OF_DELETE アクセス フラグと他の任意のアクセス フラグとの OR であり、かつリモートのファイルまたはディレクトリが FILE_SHARE_DELETE 共有アクセスで開かれていない場合に、リモート コンピューター上のファイルまたはディレクトリを削除のために開こうとすると、共有違反が発生します。このシナリオでの共有違反を回避するには、リモートのファイルまたはディレクトリを OF_DELETE アクセスのみで開くか、削除のためにファイルまたはディレクトリを開かずに DeleteFile を呼び出してください。
Windows 8 および 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) | はい |
CsvFs は、圧縮ファイルに対してリダイレクト IO を実行します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
INT OpenFile(
LPCSTR lpFileName,
OFSTRUCT* lpReOpenBuff,
DWORD uStyle
);[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int OpenFile(
[MarshalAs(UnmanagedType.LPStr)] string lpFileName, // LPCSTR
IntPtr lpReOpenBuff, // OFSTRUCT* in/out
uint uStyle // DWORD
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenFile(
<MarshalAs(UnmanagedType.LPStr)> lpFileName As String, ' LPCSTR
lpReOpenBuff As IntPtr, ' OFSTRUCT* in/out
uStyle As UInteger ' DWORD
) As Integer
End Function' lpFileName : LPCSTR
' lpReOpenBuff : OFSTRUCT* in/out
' uStyle : DWORD
Declare PtrSafe Function OpenFile Lib "kernel32" ( _
ByVal lpFileName As String, _
ByVal lpReOpenBuff As LongPtr, _
ByVal uStyle As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
OpenFile = ctypes.windll.kernel32.OpenFile
OpenFile.restype = ctypes.c_int
OpenFile.argtypes = [
wintypes.LPCSTR, # lpFileName : LPCSTR
ctypes.c_void_p, # lpReOpenBuff : OFSTRUCT* in/out
wintypes.DWORD, # uStyle : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
OpenFile = Fiddle::Function.new(
lib['OpenFile'],
[
Fiddle::TYPE_VOIDP, # lpFileName : LPCSTR
Fiddle::TYPE_VOIDP, # lpReOpenBuff : OFSTRUCT* in/out
-Fiddle::TYPE_INT, # uStyle : DWORD
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn OpenFile(
lpFileName: *const u8, // LPCSTR
lpReOpenBuff: *mut OFSTRUCT, // OFSTRUCT* in/out
uStyle: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int OpenFile([MarshalAs(UnmanagedType.LPStr)] string lpFileName, IntPtr lpReOpenBuff, uint uStyle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenFile' -Namespace Win32 -PassThru
# $api::OpenFile(lpFileName, lpReOpenBuff, uStyle)#uselib "KERNEL32.dll"
#func global OpenFile "OpenFile" sptr, sptr, sptr
; OpenFile lpFileName, varptr(lpReOpenBuff), uStyle ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; lpReOpenBuff : OFSTRUCT* in/out -> "sptr"
; uStyle : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll" #cfunc global OpenFile "OpenFile" str, var, int ; res = OpenFile(lpFileName, lpReOpenBuff, uStyle) ; lpFileName : LPCSTR -> "str" ; lpReOpenBuff : OFSTRUCT* in/out -> "var" ; uStyle : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global OpenFile "OpenFile" str, sptr, int ; res = OpenFile(lpFileName, varptr(lpReOpenBuff), uStyle) ; lpFileName : LPCSTR -> "str" ; lpReOpenBuff : OFSTRUCT* in/out -> "sptr" ; uStyle : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; INT OpenFile(LPCSTR lpFileName, OFSTRUCT* lpReOpenBuff, DWORD uStyle) #uselib "KERNEL32.dll" #cfunc global OpenFile "OpenFile" str, var, int ; res = OpenFile(lpFileName, lpReOpenBuff, uStyle) ; lpFileName : LPCSTR -> "str" ; lpReOpenBuff : OFSTRUCT* in/out -> "var" ; uStyle : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT OpenFile(LPCSTR lpFileName, OFSTRUCT* lpReOpenBuff, DWORD uStyle) #uselib "KERNEL32.dll" #cfunc global OpenFile "OpenFile" str, intptr, int ; res = OpenFile(lpFileName, varptr(lpReOpenBuff), uStyle) ; lpFileName : LPCSTR -> "str" ; lpReOpenBuff : OFSTRUCT* in/out -> "intptr" ; uStyle : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procOpenFile = kernel32.NewProc("OpenFile")
)
// lpFileName (LPCSTR), lpReOpenBuff (OFSTRUCT* in/out), uStyle (DWORD)
r1, _, err := procOpenFile.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
uintptr(lpReOpenBuff),
uintptr(uStyle),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction OpenFile(
lpFileName: PAnsiChar; // LPCSTR
lpReOpenBuff: Pointer; // OFSTRUCT* in/out
uStyle: DWORD // DWORD
): Integer; stdcall;
external 'KERNEL32.dll' name 'OpenFile';result := DllCall("KERNEL32\OpenFile"
, "AStr", lpFileName ; LPCSTR
, "Ptr", lpReOpenBuff ; OFSTRUCT* in/out
, "UInt", uStyle ; DWORD
, "Int") ; return: INT●OpenFile(lpFileName, lpReOpenBuff, uStyle) = DLL("KERNEL32.dll", "int OpenFile(char*, void*, dword)")
# 呼び出し: OpenFile(lpFileName, lpReOpenBuff, uStyle)
# lpFileName : LPCSTR -> "char*"
# lpReOpenBuff : OFSTRUCT* in/out -> "void*"
# uStyle : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn OpenFile(
lpFileName: [*c]const u8, // LPCSTR
lpReOpenBuff: [*c]OFSTRUCT, // OFSTRUCT* in/out
uStyle: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc OpenFile(
lpFileName: cstring, # LPCSTR
lpReOpenBuff: ptr OFSTRUCT, # OFSTRUCT* in/out
uStyle: uint32 # DWORD
): int32 {.importc: "OpenFile", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int OpenFile(
const(char)* lpFileName, // LPCSTR
OFSTRUCT* lpReOpenBuff, // OFSTRUCT* in/out
uint uStyle // DWORD
);ccall((:OpenFile, "KERNEL32.dll"), stdcall, Int32,
(Cstring, Ptr{OFSTRUCT}, UInt32),
lpFileName, lpReOpenBuff, uStyle)
# lpFileName : LPCSTR -> Cstring
# lpReOpenBuff : OFSTRUCT* in/out -> Ptr{OFSTRUCT}
# uStyle : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t OpenFile(
const char* lpFileName,
void* lpReOpenBuff,
uint32_t uStyle);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.OpenFile(lpFileName, lpReOpenBuff, uStyle)
-- lpFileName : LPCSTR
-- lpReOpenBuff : OFSTRUCT* in/out
-- uStyle : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const OpenFile = lib.func('__stdcall', 'OpenFile', 'int32_t', ['str', 'void *', 'uint32_t']);
// OpenFile(lpFileName, lpReOpenBuff, uStyle)
// lpFileName : LPCSTR -> 'str'
// lpReOpenBuff : OFSTRUCT* in/out -> 'void *'
// uStyle : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
OpenFile: { parameters: ["buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.OpenFile(lpFileName, lpReOpenBuff, uStyle)
// lpFileName : LPCSTR -> "buffer"
// lpReOpenBuff : OFSTRUCT* in/out -> "pointer"
// uStyle : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t OpenFile(
const char* lpFileName,
void* lpReOpenBuff,
uint32_t uStyle);
C, "KERNEL32.dll");
// $ffi->OpenFile(lpFileName, lpReOpenBuff, uStyle);
// lpFileName : LPCSTR
// lpReOpenBuff : OFSTRUCT* in/out
// uStyle : DWORD
// 構造体/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);
int OpenFile(
String lpFileName, // LPCSTR
Pointer lpReOpenBuff, // OFSTRUCT* in/out
int uStyle // DWORD
);
}@[Link("kernel32")]
lib LibKERNEL32
fun OpenFile = OpenFile(
lpFileName : UInt8*, # LPCSTR
lpReOpenBuff : OFSTRUCT*, # OFSTRUCT* in/out
uStyle : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef OpenFileNative = Int32 Function(Pointer<Utf8>, Pointer<Void>, Uint32);
typedef OpenFileDart = int Function(Pointer<Utf8>, Pointer<Void>, int);
final OpenFile = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<OpenFileNative, OpenFileDart>('OpenFile');
// lpFileName : LPCSTR -> Pointer<Utf8>
// lpReOpenBuff : OFSTRUCT* in/out -> Pointer<Void>
// uStyle : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OpenFile(
lpFileName: PAnsiChar; // LPCSTR
lpReOpenBuff: Pointer; // OFSTRUCT* in/out
uStyle: DWORD // DWORD
): Integer; stdcall;
external 'KERNEL32.dll' name 'OpenFile';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OpenFile"
c_OpenFile :: CString -> Ptr () -> Word32 -> IO Int32
-- lpFileName : LPCSTR -> CString
-- lpReOpenBuff : OFSTRUCT* in/out -> Ptr ()
-- uStyle : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let openfile =
foreign "OpenFile"
(string @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* lpReOpenBuff : OFSTRUCT* in/out -> (ptr void) *)
(* uStyle : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("OpenFile" open-file :convention :stdcall) :int32
(lp-file-name :string) ; LPCSTR
(lp-re-open-buff :pointer) ; OFSTRUCT* in/out
(u-style :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OpenFile = Win32::API::More->new('KERNEL32',
'int OpenFile(LPCSTR lpFileName, LPVOID lpReOpenBuff, DWORD uStyle)');
# my $ret = $OpenFile->Call($lpFileName, $lpReOpenBuff, $uStyle);
# lpFileName : LPCSTR -> LPCSTR
# lpReOpenBuff : OFSTRUCT* in/out -> LPVOID
# uStyle : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CreateFileW — ファイルやデバイスを作成または開いてハンドルを返す。
- f GetSystemDirectoryW — Windowsシステムディレクトリのパスを取得する(Unicode版)。
- f GetWindowsDirectoryW — Windowsディレクトリのパスを取得する(Unicode版)。
- f SearchPathW — 指定パスから条件に合うファイルを検索しフルパスを取得する。