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

BeginUpdateResourceA

関数
実行ファイルのリソース更新をANSI名で開始する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HANDLE BeginUpdateResourceA(
    LPCSTR pFileName,
    BOOL bDeleteExistingResources
);

パラメーター

名前方向説明
pFileNameLPCSTRinリソースを更新する対象のバイナリファイルです。アプリケーションはこのファイルに対する書き込みアクセスを取得できる必要があり、pFileName が参照するファイルは現在実行中であってはなりません。pFileName がフルパスを指定していない場合、システムは現在のディレクトリ内でファイルを検索します。
bDeleteExistingResourcesBOOLinpFileName パラメーターの既存のリソースを削除するかどうかを示します。このパラメーターが TRUE の場合、既存のリソースは削除され、更新後のファイルには UpdateResource 関数で追加されたリソースのみが含まれます。このパラメーターが FALSE の場合、既存のリソースは UpdateResource によって明示的に削除または置換されない限り、更新後のファイルに含まれます。

戻り値の型: HANDLE

公式ドキュメント

バイナリモジュール内のリソースを追加、削除、または置換するために UpdateResource 関数で使用できるハンドルを取得します。(ANSI)

戻り値

Type: HANDLE

関数が成功した場合、戻り値は UpdateResource 関数および EndUpdateResource 関数で使用できるハンドルです。指定されたファイルが PE でない場合、ファイルが存在しない場合、またはファイルを書き込み用に開けない場合、戻り値は NULL になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数を呼び出す前に、リソースファイルを読み込んでおかないことが推奨されます。ただし、そのファイルが既に読み込まれている場合でも、エラーが返されることはありません。

Resource Configuration(RC Config)データを含むファイル、すなわち LN ファイルおよび関連する .mui ファイルでは、リソースの更新にいくつかの制限があります。これらのファイルで更新が許可されるリソースの種類の詳細については、UpdateResource 関数の「解説」セクションを参照してください。

この関数は、コードとリソースの両方を含むモジュール内のリソースを更新できます。前述のとおり、いずれも RC Config データを含む LN ファイルおよび .mui ファイルでのリソース更新には制限があります。制限の詳細は UpdateResource 関数のリファレンスに記載されています。

例については、Updating Resources を参照してください。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして BeginUpdateResource を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 BeginUpdateResourceA(
    LPCSTR pFileName,
    BOOL bDeleteExistingResources
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr BeginUpdateResourceA(
    [MarshalAs(UnmanagedType.LPStr)] string pFileName,   // LPCSTR
    bool bDeleteExistingResources   // BOOL
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BeginUpdateResourceA(
    <MarshalAs(UnmanagedType.LPStr)> pFileName As String,   ' LPCSTR
    bDeleteExistingResources As Boolean   ' BOOL
) As IntPtr
End Function
' pFileName : LPCSTR
' bDeleteExistingResources : BOOL
Declare PtrSafe Function BeginUpdateResourceA Lib "kernel32" ( _
    ByVal pFileName As String, _
    ByVal bDeleteExistingResources As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BeginUpdateResourceA = ctypes.windll.kernel32.BeginUpdateResourceA
BeginUpdateResourceA.restype = ctypes.c_void_p
BeginUpdateResourceA.argtypes = [
    wintypes.LPCSTR,  # pFileName : LPCSTR
    wintypes.BOOL,  # bDeleteExistingResources : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
BeginUpdateResourceA = Fiddle::Function.new(
  lib['BeginUpdateResourceA'],
  [
    Fiddle::TYPE_VOIDP,  # pFileName : LPCSTR
    Fiddle::TYPE_INT,  # bDeleteExistingResources : BOOL
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn BeginUpdateResourceA(
        pFileName: *const u8,  // LPCSTR
        bDeleteExistingResources: i32  // BOOL
    ) -> *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 BeginUpdateResourceA([MarshalAs(UnmanagedType.LPStr)] string pFileName, bool bDeleteExistingResources);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_BeginUpdateResourceA' -Namespace Win32 -PassThru
# $api::BeginUpdateResourceA(pFileName, bDeleteExistingResources)
#uselib "KERNEL32.dll"
#func global BeginUpdateResourceA "BeginUpdateResourceA" sptr, sptr
; BeginUpdateResourceA pFileName, bDeleteExistingResources   ; 戻り値は stat
; pFileName : LPCSTR -> "sptr"
; bDeleteExistingResources : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global BeginUpdateResourceA "BeginUpdateResourceA" str, int
; res = BeginUpdateResourceA(pFileName, bDeleteExistingResources)
; pFileName : LPCSTR -> "str"
; bDeleteExistingResources : BOOL -> "int"
; HANDLE BeginUpdateResourceA(LPCSTR pFileName, BOOL bDeleteExistingResources)
#uselib "KERNEL32.dll"
#cfunc global BeginUpdateResourceA "BeginUpdateResourceA" str, int
; res = BeginUpdateResourceA(pFileName, bDeleteExistingResources)
; pFileName : LPCSTR -> "str"
; bDeleteExistingResources : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procBeginUpdateResourceA = kernel32.NewProc("BeginUpdateResourceA")
)

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

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

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

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

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

(cffi:defcfun ("BeginUpdateResourceA" begin-update-resource-a :convention :stdcall) :pointer
  (p-file-name :string)   ; LPCSTR
  (b-delete-existing-resources :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BeginUpdateResourceA = Win32::API::More->new('KERNEL32',
    'HANDLE BeginUpdateResourceA(LPCSTR pFileName, BOOL bDeleteExistingResources)');
# my $ret = $BeginUpdateResourceA->Call($pFileName, $bDeleteExistingResources);
# pFileName : LPCSTR -> LPCSTR
# bDeleteExistingResources : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目