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

TestApplyPatchToFileW

関数
パッチが旧ファイルに適用可能かを実適用せずに検証する(Unicode版)。
DLLmspatcha.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

BOOL TestApplyPatchToFileW(
    LPCWSTR PatchFileName,
    LPCWSTR OldFileName,
    DWORD ApplyOptionFlags
);

パラメーター

名前方向説明
PatchFileNameLPCWSTRin適用可否を検証するパッチファイルのパス。Unicode 文字列で指定する。
OldFileNameLPCWSTRinパッチ適用先となる旧ファイルのパス。Unicode 文字列で指定する。
ApplyOptionFlagsDWORDin適用検証動作を制御するフラグ。APPLY_OPTION_* の組み合わせを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL TestApplyPatchToFileW(
    LPCWSTR PatchFileName,
    LPCWSTR OldFileName,
    DWORD ApplyOptionFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mspatcha.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool TestApplyPatchToFileW(
    [MarshalAs(UnmanagedType.LPWStr)] string PatchFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string OldFileName,   // LPCWSTR
    uint ApplyOptionFlags   // DWORD
);
<DllImport("mspatcha.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function TestApplyPatchToFileW(
    <MarshalAs(UnmanagedType.LPWStr)> PatchFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> OldFileName As String,   ' LPCWSTR
    ApplyOptionFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' PatchFileName : LPCWSTR
' OldFileName : LPCWSTR
' ApplyOptionFlags : DWORD
Declare PtrSafe Function TestApplyPatchToFileW Lib "mspatcha" ( _
    ByVal PatchFileName As LongPtr, _
    ByVal OldFileName As LongPtr, _
    ByVal ApplyOptionFlags As Long) As Long
' 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

TestApplyPatchToFileW = ctypes.windll.mspatcha.TestApplyPatchToFileW
TestApplyPatchToFileW.restype = wintypes.BOOL
TestApplyPatchToFileW.argtypes = [
    wintypes.LPCWSTR,  # PatchFileName : LPCWSTR
    wintypes.LPCWSTR,  # OldFileName : LPCWSTR
    wintypes.DWORD,  # ApplyOptionFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mspatcha = windows.NewLazySystemDLL("mspatcha.dll")
	procTestApplyPatchToFileW = mspatcha.NewProc("TestApplyPatchToFileW")
)

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

extern "mspatcha" fn TestApplyPatchToFileW(
    PatchFileName: [*c]const u16, // LPCWSTR
    OldFileName: [*c]const u16, // LPCWSTR
    ApplyOptionFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc TestApplyPatchToFileW(
    PatchFileName: WideCString,  # LPCWSTR
    OldFileName: WideCString,  # LPCWSTR
    ApplyOptionFlags: uint32  # DWORD
): int32 {.importc: "TestApplyPatchToFileW", stdcall, dynlib: "mspatcha.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "mspatcha");
extern(Windows)
int TestApplyPatchToFileW(
    const(wchar)* PatchFileName,   // LPCWSTR
    const(wchar)* OldFileName,   // LPCWSTR
    uint ApplyOptionFlags   // DWORD
);
ccall((:TestApplyPatchToFileW, "mspatcha.dll"), stdcall, Int32,
      (Cwstring, Cwstring, UInt32),
      PatchFileName, OldFileName, ApplyOptionFlags)
# PatchFileName : LPCWSTR -> Cwstring
# OldFileName : LPCWSTR -> Cwstring
# ApplyOptionFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t TestApplyPatchToFileW(
    const uint16_t* PatchFileName,
    const uint16_t* OldFileName,
    uint32_t ApplyOptionFlags);
]]
local mspatcha = ffi.load("mspatcha")
-- mspatcha.TestApplyPatchToFileW(PatchFileName, OldFileName, ApplyOptionFlags)
-- PatchFileName : LPCWSTR
-- OldFileName : LPCWSTR
-- ApplyOptionFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('mspatcha.dll');
const TestApplyPatchToFileW = lib.func('__stdcall', 'TestApplyPatchToFileW', 'int32_t', ['str16', 'str16', 'uint32_t']);
// TestApplyPatchToFileW(PatchFileName, OldFileName, ApplyOptionFlags)
// PatchFileName : LPCWSTR -> 'str16'
// OldFileName : LPCWSTR -> 'str16'
// ApplyOptionFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("mspatcha.dll", {
  TestApplyPatchToFileW: { parameters: ["buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.TestApplyPatchToFileW(PatchFileName, OldFileName, ApplyOptionFlags)
// PatchFileName : LPCWSTR -> "buffer"
// OldFileName : LPCWSTR -> "buffer"
// ApplyOptionFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TestApplyPatchToFileW(
    const uint16_t* PatchFileName,
    const uint16_t* OldFileName,
    uint32_t ApplyOptionFlags);
C, "mspatcha.dll");
// $ffi->TestApplyPatchToFileW(PatchFileName, OldFileName, ApplyOptionFlags);
// PatchFileName : LPCWSTR
// OldFileName : LPCWSTR
// ApplyOptionFlags : 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 Mspatcha extends StdCallLibrary {
    Mspatcha INSTANCE = Native.load("mspatcha", Mspatcha.class, W32APIOptions.UNICODE_OPTIONS);
    boolean TestApplyPatchToFileW(
        WString PatchFileName,   // LPCWSTR
        WString OldFileName,   // LPCWSTR
        int ApplyOptionFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("mspatcha")]
lib Libmspatcha
  fun TestApplyPatchToFileW = TestApplyPatchToFileW(
    PatchFileName : UInt16*,   # LPCWSTR
    OldFileName : UInt16*,   # LPCWSTR
    ApplyOptionFlags : 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 TestApplyPatchToFileWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef TestApplyPatchToFileWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final TestApplyPatchToFileW = DynamicLibrary.open('mspatcha.dll')
    .lookupFunction<TestApplyPatchToFileWNative, TestApplyPatchToFileWDart>('TestApplyPatchToFileW');
// PatchFileName : LPCWSTR -> Pointer<Utf16>
// OldFileName : LPCWSTR -> Pointer<Utf16>
// ApplyOptionFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TestApplyPatchToFileW(
  PatchFileName: PWideChar;   // LPCWSTR
  OldFileName: PWideChar;   // LPCWSTR
  ApplyOptionFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'mspatcha.dll' name 'TestApplyPatchToFileW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TestApplyPatchToFileW"
  c_TestApplyPatchToFileW :: CWString -> CWString -> Word32 -> IO CInt
-- PatchFileName : LPCWSTR -> CWString
-- OldFileName : LPCWSTR -> CWString
-- ApplyOptionFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let testapplypatchtofilew =
  foreign "TestApplyPatchToFileW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* PatchFileName : LPCWSTR -> (ptr uint16_t) *)
(* OldFileName : LPCWSTR -> (ptr uint16_t) *)
(* ApplyOptionFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mspatcha (t "mspatcha.dll"))
(cffi:use-foreign-library mspatcha)

(cffi:defcfun ("TestApplyPatchToFileW" test-apply-patch-to-file-w :convention :stdcall) :int32
  (patch-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (old-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (apply-option-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TestApplyPatchToFileW = Win32::API::More->new('mspatcha',
    'BOOL TestApplyPatchToFileW(LPCWSTR PatchFileName, LPCWSTR OldFileName, DWORD ApplyOptionFlags)');
# my $ret = $TestApplyPatchToFileW->Call($PatchFileName, $OldFileName, $ApplyOptionFlags);
# PatchFileName : LPCWSTR -> LPCWSTR
# OldFileName : LPCWSTR -> LPCWSTR
# ApplyOptionFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い