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

EndUpdateResourceA

関数
リソース更新を確定または破棄して終了する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL EndUpdateResourceA(
    HANDLE hUpdate,
    BOOL fDiscard
);

パラメーター

名前方向説明
hUpdateHANDLEinBeginUpdateResource 関数によって返され、UpdateResource で使用されるモジュール ハンドルで、更新対象のファイルを参照します。
fDiscardBOOLinリソースの更新をファイルに書き込むかどうかを示します。このパラメーターが TRUE の場合、変更は行われません。FALSE の場合、変更が行われ、リソースの更新が反映されます。

戻り値の型: BOOL

公式ドキュメント

UpdateResource の呼び出し前に行われた変更をコミットまたは破棄します。(ANSI)

戻り値

型: BOOL

関数が成功した場合は TRUE を、それ以外の場合は FALSE を返します。関数が成功し、かつ fDiscardTRUE の場合、ファイルへのリソース更新は行われません。そうでない場合は、成功したすべてのリソース更新がファイルに反映されます。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数を呼び出す前に、BeginUpdateResource によって返されたハンドル以外のすべてのファイル ハンドルが閉じられていることを確認してください。

この関数は、コードとリソースの両方を含むモジュール内のリソースを更新できます。Resource Configuration データを含む LN ファイルおよび .mui ファイルでは、リソースの更新に制限があります。制限の詳細については、UpdateResource 関数のリファレンスを参照してください。

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

メモ

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

BOOL EndUpdateResourceA(
    HANDLE hUpdate,
    BOOL fDiscard
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EndUpdateResourceA(
    IntPtr hUpdate,   // HANDLE
    bool fDiscard   // BOOL
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EndUpdateResourceA(
    hUpdate As IntPtr,   ' HANDLE
    fDiscard As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hUpdate : HANDLE
' fDiscard : BOOL
Declare PtrSafe Function EndUpdateResourceA Lib "kernel32" ( _
    ByVal hUpdate As LongPtr, _
    ByVal fDiscard As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EndUpdateResourceA = ctypes.windll.kernel32.EndUpdateResourceA
EndUpdateResourceA.restype = wintypes.BOOL
EndUpdateResourceA.argtypes = [
    wintypes.HANDLE,  # hUpdate : HANDLE
    wintypes.BOOL,  # fDiscard : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
EndUpdateResourceA = Fiddle::Function.new(
  lib['EndUpdateResourceA'],
  [
    Fiddle::TYPE_VOIDP,  # hUpdate : HANDLE
    Fiddle::TYPE_INT,  # fDiscard : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn EndUpdateResourceA(
        hUpdate: *mut core::ffi::c_void,  // HANDLE
        fDiscard: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool EndUpdateResourceA(IntPtr hUpdate, bool fDiscard);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EndUpdateResourceA' -Namespace Win32 -PassThru
# $api::EndUpdateResourceA(hUpdate, fDiscard)
#uselib "KERNEL32.dll"
#func global EndUpdateResourceA "EndUpdateResourceA" sptr, sptr
; EndUpdateResourceA hUpdate, fDiscard   ; 戻り値は stat
; hUpdate : HANDLE -> "sptr"
; fDiscard : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global EndUpdateResourceA "EndUpdateResourceA" sptr, int
; res = EndUpdateResourceA(hUpdate, fDiscard)
; hUpdate : HANDLE -> "sptr"
; fDiscard : BOOL -> "int"
; BOOL EndUpdateResourceA(HANDLE hUpdate, BOOL fDiscard)
#uselib "KERNEL32.dll"
#cfunc global EndUpdateResourceA "EndUpdateResourceA" intptr, int
; res = EndUpdateResourceA(hUpdate, fDiscard)
; hUpdate : HANDLE -> "intptr"
; fDiscard : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEndUpdateResourceA = kernel32.NewProc("EndUpdateResourceA")
)

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

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

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

foreign import stdcall safe "EndUpdateResourceA"
  c_EndUpdateResourceA :: Ptr () -> CInt -> IO CInt
-- hUpdate : HANDLE -> Ptr ()
-- fDiscard : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let endupdateresourcea =
  foreign "EndUpdateResourceA"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* hUpdate : HANDLE -> (ptr void) *)
(* fDiscard : 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 ("EndUpdateResourceA" end-update-resource-a :convention :stdcall) :int32
  (h-update :pointer)   ; HANDLE
  (f-discard :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EndUpdateResourceA = Win32::API::More->new('KERNEL32',
    'BOOL EndUpdateResourceA(HANDLE hUpdate, BOOL fDiscard)');
# my $ret = $EndUpdateResourceA->Call($hUpdate, $fDiscard);
# hUpdate : HANDLE -> HANDLE
# fDiscard : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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