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

GetFilePatchSignatureW

関数
パッチ用にファイルの署名値を計算して取得する(Unicode版)。
DLLmspatcha.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

BOOL GetFilePatchSignatureW(
    LPCWSTR FileName,
    DWORD OptionFlags,
    void* OptionData,   // optional
    DWORD IgnoreRangeCount,
    PATCH_IGNORE_RANGE* IgnoreRangeArray,   // optional
    DWORD RetainRangeCount,
    PATCH_RETAIN_RANGE* RetainRangeArray,   // optional
    DWORD SignatureBufferSize,
    LPWSTR SignatureBuffer
);

パラメーター

名前方向
FileNameLPCWSTRin
OptionFlagsDWORDin
OptionDatavoid*inoptional
IgnoreRangeCountDWORDin
IgnoreRangeArrayPATCH_IGNORE_RANGE*inoptional
RetainRangeCountDWORDin
RetainRangeArrayPATCH_RETAIN_RANGE*inoptional
SignatureBufferSizeDWORDin
SignatureBufferLPWSTRout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetFilePatchSignatureW(
    LPCWSTR FileName,
    DWORD OptionFlags,
    void* OptionData,   // optional
    DWORD IgnoreRangeCount,
    PATCH_IGNORE_RANGE* IgnoreRangeArray,   // optional
    DWORD RetainRangeCount,
    PATCH_RETAIN_RANGE* RetainRangeArray,   // optional
    DWORD SignatureBufferSize,
    LPWSTR SignatureBuffer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mspatcha.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetFilePatchSignatureW(
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // LPCWSTR
    uint OptionFlags,   // DWORD
    IntPtr OptionData,   // void* optional
    uint IgnoreRangeCount,   // DWORD
    IntPtr IgnoreRangeArray,   // PATCH_IGNORE_RANGE* optional
    uint RetainRangeCount,   // DWORD
    IntPtr RetainRangeArray,   // PATCH_RETAIN_RANGE* optional
    uint SignatureBufferSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder SignatureBuffer   // LPWSTR out
);
<DllImport("mspatcha.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetFilePatchSignatureW(
    <MarshalAs(UnmanagedType.LPWStr)> FileName As String,   ' LPCWSTR
    OptionFlags As UInteger,   ' DWORD
    OptionData As IntPtr,   ' void* optional
    IgnoreRangeCount As UInteger,   ' DWORD
    IgnoreRangeArray As IntPtr,   ' PATCH_IGNORE_RANGE* optional
    RetainRangeCount As UInteger,   ' DWORD
    RetainRangeArray As IntPtr,   ' PATCH_RETAIN_RANGE* optional
    SignatureBufferSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> SignatureBuffer As System.Text.StringBuilder   ' LPWSTR out
) As Boolean
End Function
' FileName : LPCWSTR
' OptionFlags : DWORD
' OptionData : void* optional
' IgnoreRangeCount : DWORD
' IgnoreRangeArray : PATCH_IGNORE_RANGE* optional
' RetainRangeCount : DWORD
' RetainRangeArray : PATCH_RETAIN_RANGE* optional
' SignatureBufferSize : DWORD
' SignatureBuffer : LPWSTR out
Declare PtrSafe Function GetFilePatchSignatureW Lib "mspatcha" ( _
    ByVal FileName As LongPtr, _
    ByVal OptionFlags As Long, _
    ByVal OptionData As LongPtr, _
    ByVal IgnoreRangeCount As Long, _
    ByVal IgnoreRangeArray As LongPtr, _
    ByVal RetainRangeCount As Long, _
    ByVal RetainRangeArray As LongPtr, _
    ByVal SignatureBufferSize As Long, _
    ByVal SignatureBuffer As LongPtr) 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

GetFilePatchSignatureW = ctypes.windll.mspatcha.GetFilePatchSignatureW
GetFilePatchSignatureW.restype = wintypes.BOOL
GetFilePatchSignatureW.argtypes = [
    wintypes.LPCWSTR,  # FileName : LPCWSTR
    wintypes.DWORD,  # OptionFlags : DWORD
    ctypes.POINTER(None),  # OptionData : void* optional
    wintypes.DWORD,  # IgnoreRangeCount : DWORD
    ctypes.c_void_p,  # IgnoreRangeArray : PATCH_IGNORE_RANGE* optional
    wintypes.DWORD,  # RetainRangeCount : DWORD
    ctypes.c_void_p,  # RetainRangeArray : PATCH_RETAIN_RANGE* optional
    wintypes.DWORD,  # SignatureBufferSize : DWORD
    wintypes.LPWSTR,  # SignatureBuffer : LPWSTR out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mspatcha.dll')
GetFilePatchSignatureW = Fiddle::Function.new(
  lib['GetFilePatchSignatureW'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCWSTR
    -Fiddle::TYPE_INT,  # OptionFlags : DWORD
    Fiddle::TYPE_VOIDP,  # OptionData : void* optional
    -Fiddle::TYPE_INT,  # IgnoreRangeCount : DWORD
    Fiddle::TYPE_VOIDP,  # IgnoreRangeArray : PATCH_IGNORE_RANGE* optional
    -Fiddle::TYPE_INT,  # RetainRangeCount : DWORD
    Fiddle::TYPE_VOIDP,  # RetainRangeArray : PATCH_RETAIN_RANGE* optional
    -Fiddle::TYPE_INT,  # SignatureBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # SignatureBuffer : LPWSTR out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "mspatcha")]
extern "system" {
    fn GetFilePatchSignatureW(
        FileName: *const u16,  // LPCWSTR
        OptionFlags: u32,  // DWORD
        OptionData: *mut (),  // void* optional
        IgnoreRangeCount: u32,  // DWORD
        IgnoreRangeArray: *mut PATCH_IGNORE_RANGE,  // PATCH_IGNORE_RANGE* optional
        RetainRangeCount: u32,  // DWORD
        RetainRangeArray: *mut PATCH_RETAIN_RANGE,  // PATCH_RETAIN_RANGE* optional
        SignatureBufferSize: u32,  // DWORD
        SignatureBuffer: *mut u16  // LPWSTR out
    ) -> 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 GetFilePatchSignatureW([MarshalAs(UnmanagedType.LPWStr)] string FileName, uint OptionFlags, IntPtr OptionData, uint IgnoreRangeCount, IntPtr IgnoreRangeArray, uint RetainRangeCount, IntPtr RetainRangeArray, uint SignatureBufferSize, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder SignatureBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mspatcha_GetFilePatchSignatureW' -Namespace Win32 -PassThru
# $api::GetFilePatchSignatureW(FileName, OptionFlags, OptionData, IgnoreRangeCount, IgnoreRangeArray, RetainRangeCount, RetainRangeArray, SignatureBufferSize, SignatureBuffer)
#uselib "mspatcha.dll"
#func global GetFilePatchSignatureW "GetFilePatchSignatureW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; GetFilePatchSignatureW FileName, OptionFlags, OptionData, IgnoreRangeCount, varptr(IgnoreRangeArray), RetainRangeCount, varptr(RetainRangeArray), SignatureBufferSize, varptr(SignatureBuffer)   ; 戻り値は stat
; FileName : LPCWSTR -> "wptr"
; OptionFlags : DWORD -> "wptr"
; OptionData : void* optional -> "wptr"
; IgnoreRangeCount : DWORD -> "wptr"
; IgnoreRangeArray : PATCH_IGNORE_RANGE* optional -> "wptr"
; RetainRangeCount : DWORD -> "wptr"
; RetainRangeArray : PATCH_RETAIN_RANGE* optional -> "wptr"
; SignatureBufferSize : DWORD -> "wptr"
; SignatureBuffer : LPWSTR out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "mspatcha.dll"
#cfunc global GetFilePatchSignatureW "GetFilePatchSignatureW" wstr, int, sptr, int, var, int, var, int, var
; res = GetFilePatchSignatureW(FileName, OptionFlags, OptionData, IgnoreRangeCount, IgnoreRangeArray, RetainRangeCount, RetainRangeArray, SignatureBufferSize, SignatureBuffer)
; FileName : LPCWSTR -> "wstr"
; OptionFlags : DWORD -> "int"
; OptionData : void* optional -> "sptr"
; IgnoreRangeCount : DWORD -> "int"
; IgnoreRangeArray : PATCH_IGNORE_RANGE* optional -> "var"
; RetainRangeCount : DWORD -> "int"
; RetainRangeArray : PATCH_RETAIN_RANGE* optional -> "var"
; SignatureBufferSize : DWORD -> "int"
; SignatureBuffer : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetFilePatchSignatureW(LPCWSTR FileName, DWORD OptionFlags, void* OptionData, DWORD IgnoreRangeCount, PATCH_IGNORE_RANGE* IgnoreRangeArray, DWORD RetainRangeCount, PATCH_RETAIN_RANGE* RetainRangeArray, DWORD SignatureBufferSize, LPWSTR SignatureBuffer)
#uselib "mspatcha.dll"
#cfunc global GetFilePatchSignatureW "GetFilePatchSignatureW" wstr, int, intptr, int, var, int, var, int, var
; res = GetFilePatchSignatureW(FileName, OptionFlags, OptionData, IgnoreRangeCount, IgnoreRangeArray, RetainRangeCount, RetainRangeArray, SignatureBufferSize, SignatureBuffer)
; FileName : LPCWSTR -> "wstr"
; OptionFlags : DWORD -> "int"
; OptionData : void* optional -> "intptr"
; IgnoreRangeCount : DWORD -> "int"
; IgnoreRangeArray : PATCH_IGNORE_RANGE* optional -> "var"
; RetainRangeCount : DWORD -> "int"
; RetainRangeArray : PATCH_RETAIN_RANGE* optional -> "var"
; SignatureBufferSize : DWORD -> "int"
; SignatureBuffer : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mspatcha = windows.NewLazySystemDLL("mspatcha.dll")
	procGetFilePatchSignatureW = mspatcha.NewProc("GetFilePatchSignatureW")
)

// FileName (LPCWSTR), OptionFlags (DWORD), OptionData (void* optional), IgnoreRangeCount (DWORD), IgnoreRangeArray (PATCH_IGNORE_RANGE* optional), RetainRangeCount (DWORD), RetainRangeArray (PATCH_RETAIN_RANGE* optional), SignatureBufferSize (DWORD), SignatureBuffer (LPWSTR out)
r1, _, err := procGetFilePatchSignatureW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(FileName))),
	uintptr(OptionFlags),
	uintptr(OptionData),
	uintptr(IgnoreRangeCount),
	uintptr(IgnoreRangeArray),
	uintptr(RetainRangeCount),
	uintptr(RetainRangeArray),
	uintptr(SignatureBufferSize),
	uintptr(SignatureBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetFilePatchSignatureW(
  FileName: PWideChar;   // LPCWSTR
  OptionFlags: DWORD;   // DWORD
  OptionData: Pointer;   // void* optional
  IgnoreRangeCount: DWORD;   // DWORD
  IgnoreRangeArray: Pointer;   // PATCH_IGNORE_RANGE* optional
  RetainRangeCount: DWORD;   // DWORD
  RetainRangeArray: Pointer;   // PATCH_RETAIN_RANGE* optional
  SignatureBufferSize: DWORD;   // DWORD
  SignatureBuffer: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'mspatcha.dll' name 'GetFilePatchSignatureW';
result := DllCall("mspatcha\GetFilePatchSignatureW"
    , "WStr", FileName   ; LPCWSTR
    , "UInt", OptionFlags   ; DWORD
    , "Ptr", OptionData   ; void* optional
    , "UInt", IgnoreRangeCount   ; DWORD
    , "Ptr", IgnoreRangeArray   ; PATCH_IGNORE_RANGE* optional
    , "UInt", RetainRangeCount   ; DWORD
    , "Ptr", RetainRangeArray   ; PATCH_RETAIN_RANGE* optional
    , "UInt", SignatureBufferSize   ; DWORD
    , "Ptr", SignatureBuffer   ; LPWSTR out
    , "Int")   ; return: BOOL
●GetFilePatchSignatureW(FileName, OptionFlags, OptionData, IgnoreRangeCount, IgnoreRangeArray, RetainRangeCount, RetainRangeArray, SignatureBufferSize, SignatureBuffer) = DLL("mspatcha.dll", "bool GetFilePatchSignatureW(char*, dword, void*, dword, void*, dword, void*, dword, char*)")
# 呼び出し: GetFilePatchSignatureW(FileName, OptionFlags, OptionData, IgnoreRangeCount, IgnoreRangeArray, RetainRangeCount, RetainRangeArray, SignatureBufferSize, SignatureBuffer)
# FileName : LPCWSTR -> "char*"
# OptionFlags : DWORD -> "dword"
# OptionData : void* optional -> "void*"
# IgnoreRangeCount : DWORD -> "dword"
# IgnoreRangeArray : PATCH_IGNORE_RANGE* optional -> "void*"
# RetainRangeCount : DWORD -> "dword"
# RetainRangeArray : PATCH_RETAIN_RANGE* optional -> "void*"
# SignatureBufferSize : DWORD -> "dword"
# SignatureBuffer : LPWSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。