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

ApplyPatchToFileExA

関数
進捗コールバック付きで旧ファイルにパッチを適用する(ANSI版)。
DLLmspatcha.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

BOOL ApplyPatchToFileExA(
    LPCSTR PatchFileName,
    LPCSTR OldFileName,   // optional
    LPCSTR NewFileName,
    DWORD ApplyOptionFlags,
    PPATCH_PROGRESS_CALLBACK ProgressCallback,   // optional
    void* CallbackContext   // optional
);

パラメーター

名前型方向説明
PatchFileNameLPCSTRin適用するパッチファイルのパス。ANSI 文字列で指定する。
OldFileNameLPCSTRinoptionalパッチ適用先となる旧ファイルのパス。ANSI 文字列で指定する。
NewFileNameLPCSTRin適用結果を書き込む新ファイルの出力パス。ANSI 文字列で指定する。
ApplyOptionFlagsDWORDin適用動作を制御するフラグ。APPLY_OPTION_* の組み合わせを指定する。
ProgressCallbackPPATCH_PROGRESS_CALLBACKinoptional進捗を通知するコールバック関数。不要なら NULL を指定する。
CallbackContextvoid*inoptionalコールバックへ渡されるユーザー定義のコンテキストポインタ。NULL 可。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ApplyPatchToFileExA(
    LPCSTR PatchFileName,
    LPCSTR OldFileName,   // optional
    LPCSTR NewFileName,
    DWORD ApplyOptionFlags,
    PPATCH_PROGRESS_CALLBACK ProgressCallback,   // optional
    void* CallbackContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mspatcha.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool ApplyPatchToFileExA(
    [MarshalAs(UnmanagedType.LPStr)] string PatchFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string OldFileName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string NewFileName,   // LPCSTR
    uint ApplyOptionFlags,   // DWORD
    IntPtr ProgressCallback,   // PPATCH_PROGRESS_CALLBACK optional
    IntPtr CallbackContext   // void* optional
);
<DllImport("mspatcha.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ApplyPatchToFileExA(
    <MarshalAs(UnmanagedType.LPStr)> PatchFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> OldFileName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> NewFileName As String,   ' LPCSTR
    ApplyOptionFlags As UInteger,   ' DWORD
    ProgressCallback As IntPtr,   ' PPATCH_PROGRESS_CALLBACK optional
    CallbackContext As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' PatchFileName : LPCSTR
' OldFileName : LPCSTR optional
' NewFileName : LPCSTR
' ApplyOptionFlags : DWORD
' ProgressCallback : PPATCH_PROGRESS_CALLBACK optional
' CallbackContext : void* optional
Declare PtrSafe Function ApplyPatchToFileExA Lib "mspatcha" ( _
    ByVal PatchFileName As String, _
    ByVal OldFileName As String, _
    ByVal NewFileName As String, _
    ByVal ApplyOptionFlags As Long, _
    ByVal ProgressCallback As LongPtr, _
    ByVal CallbackContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ApplyPatchToFileExA = ctypes.windll.mspatcha.ApplyPatchToFileExA
ApplyPatchToFileExA.restype = wintypes.BOOL
ApplyPatchToFileExA.argtypes = [
    wintypes.LPCSTR,  # PatchFileName : LPCSTR
    wintypes.LPCSTR,  # OldFileName : LPCSTR optional
    wintypes.LPCSTR,  # NewFileName : LPCSTR
    wintypes.DWORD,  # ApplyOptionFlags : DWORD
    ctypes.c_void_p,  # ProgressCallback : PPATCH_PROGRESS_CALLBACK optional
    ctypes.POINTER(None),  # CallbackContext : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mspatcha = windows.NewLazySystemDLL("mspatcha.dll")
	procApplyPatchToFileExA = mspatcha.NewProc("ApplyPatchToFileExA")
)

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

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

typedef ApplyPatchToFileExANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Void>, Pointer<Void>);
typedef ApplyPatchToFileExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Void>, Pointer<Void>);
final ApplyPatchToFileExA = DynamicLibrary.open('mspatcha.dll')
    .lookupFunction<ApplyPatchToFileExANative, ApplyPatchToFileExADart>('ApplyPatchToFileExA');
// PatchFileName : LPCSTR -> Pointer<Utf8>
// OldFileName : LPCSTR optional -> Pointer<Utf8>
// NewFileName : LPCSTR -> Pointer<Utf8>
// ApplyOptionFlags : DWORD -> Uint32
// ProgressCallback : PPATCH_PROGRESS_CALLBACK optional -> Pointer<Void>
// CallbackContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ApplyPatchToFileExA(
  PatchFileName: PAnsiChar;   // LPCSTR
  OldFileName: PAnsiChar;   // LPCSTR optional
  NewFileName: PAnsiChar;   // LPCSTR
  ApplyOptionFlags: DWORD;   // DWORD
  ProgressCallback: Pointer;   // PPATCH_PROGRESS_CALLBACK optional
  CallbackContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'mspatcha.dll' name 'ApplyPatchToFileExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ApplyPatchToFileExA"
  c_ApplyPatchToFileExA :: CString -> CString -> CString -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- PatchFileName : LPCSTR -> CString
-- OldFileName : LPCSTR optional -> CString
-- NewFileName : LPCSTR -> CString
-- ApplyOptionFlags : DWORD -> Word32
-- ProgressCallback : PPATCH_PROGRESS_CALLBACK optional -> Ptr ()
-- CallbackContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let applypatchtofileexa =
  foreign "ApplyPatchToFileExA"
    (string @-> string @-> string @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* PatchFileName : LPCSTR -> string *)
(* OldFileName : LPCSTR optional -> string *)
(* NewFileName : LPCSTR -> string *)
(* ApplyOptionFlags : DWORD -> uint32_t *)
(* ProgressCallback : PPATCH_PROGRESS_CALLBACK optional -> (ptr void) *)
(* CallbackContext : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mspatcha (t "mspatcha.dll"))
(cffi:use-foreign-library mspatcha)

(cffi:defcfun ("ApplyPatchToFileExA" apply-patch-to-file-ex-a :convention :stdcall) :int32
  (patch-file-name :string)   ; LPCSTR
  (old-file-name :string)   ; LPCSTR optional
  (new-file-name :string)   ; LPCSTR
  (apply-option-flags :uint32)   ; DWORD
  (progress-callback :pointer)   ; PPATCH_PROGRESS_CALLBACK optional
  (callback-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ApplyPatchToFileExA = Win32::API::More->new('mspatcha',
    'BOOL ApplyPatchToFileExA(LPCSTR PatchFileName, LPCSTR OldFileName, LPCSTR NewFileName, DWORD ApplyOptionFlags, LPVOID ProgressCallback, LPVOID CallbackContext)');
# my $ret = $ApplyPatchToFileExA->Call($PatchFileName, $OldFileName, $NewFileName, $ApplyOptionFlags, $ProgressCallback, $CallbackContext);
# PatchFileName : LPCSTR -> LPCSTR
# OldFileName : LPCSTR optional -> LPCSTR
# NewFileName : LPCSTR -> LPCSTR
# ApplyOptionFlags : DWORD -> DWORD
# ProgressCallback : PPATCH_PROGRESS_CALLBACK optional -> LPVOID
# CallbackContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

文字セット違い
類似 API
使用する型