Win32 API 日本語リファレンス
ホーム › Devices.DeviceAndDriverInstallation › SetupRenameErrorA

SetupRenameErrorA

関数
ファイル名変更エラーを通知するダイアログを表示する(ANSI)。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD SetupRenameErrorA(
    HWND hwndParent,
    LPCSTR DialogTitle,   // optional
    LPCSTR SourceFile,
    LPCSTR TargetFile,
    DWORD Win32ErrorCode,
    DWORD Style
);

パラメーター

名前型方向説明
hwndParentHWNDinエラーダイアログの親ウィンドウハンドル。NULL可。
DialogTitleLPCSTRinoptionalダイアログのタイトル文字列(ANSI)。NULLで既定値を使う。
SourceFileLPCSTRinリネーム元ファイル名(ANSI)。
TargetFileLPCSTRinリネーム先ファイル名(ANSI)。
Win32ErrorCodeDWORDin発生したWin32エラーコード。表示メッセージの決定に使う。
StyleDWORDinダイアログの表示動作を制御するスタイルフラグ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD SetupRenameErrorA(
    HWND hwndParent,
    LPCSTR DialogTitle,   // optional
    LPCSTR SourceFile,
    LPCSTR TargetFile,
    DWORD Win32ErrorCode,
    DWORD Style
);
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint SetupRenameErrorA(
    IntPtr hwndParent,   // HWND
    [MarshalAs(UnmanagedType.LPStr)] string DialogTitle,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string SourceFile,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string TargetFile,   // LPCSTR
    uint Win32ErrorCode,   // DWORD
    uint Style   // DWORD
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupRenameErrorA(
    hwndParent As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPStr)> DialogTitle As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> SourceFile As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> TargetFile As String,   ' LPCSTR
    Win32ErrorCode As UInteger,   ' DWORD
    Style As UInteger   ' DWORD
) As UInteger
End Function
' hwndParent : HWND
' DialogTitle : LPCSTR optional
' SourceFile : LPCSTR
' TargetFile : LPCSTR
' Win32ErrorCode : DWORD
' Style : DWORD
Declare PtrSafe Function SetupRenameErrorA Lib "setupapi" ( _
    ByVal hwndParent As LongPtr, _
    ByVal DialogTitle As String, _
    ByVal SourceFile As String, _
    ByVal TargetFile As String, _
    ByVal Win32ErrorCode As Long, _
    ByVal Style As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupRenameErrorA = ctypes.windll.setupapi.SetupRenameErrorA
SetupRenameErrorA.restype = wintypes.DWORD
SetupRenameErrorA.argtypes = [
    wintypes.HANDLE,  # hwndParent : HWND
    wintypes.LPCSTR,  # DialogTitle : LPCSTR optional
    wintypes.LPCSTR,  # SourceFile : LPCSTR
    wintypes.LPCSTR,  # TargetFile : LPCSTR
    wintypes.DWORD,  # Win32ErrorCode : DWORD
    wintypes.DWORD,  # Style : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupRenameErrorA = Fiddle::Function.new(
  lib['SetupRenameErrorA'],
  [
    Fiddle::TYPE_VOIDP,  # hwndParent : HWND
    Fiddle::TYPE_VOIDP,  # DialogTitle : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # SourceFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # TargetFile : LPCSTR
    -Fiddle::TYPE_INT,  # Win32ErrorCode : DWORD
    -Fiddle::TYPE_INT,  # Style : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupRenameErrorA(
        hwndParent: *mut core::ffi::c_void,  // HWND
        DialogTitle: *const u8,  // LPCSTR optional
        SourceFile: *const u8,  // LPCSTR
        TargetFile: *const u8,  // LPCSTR
        Win32ErrorCode: u32,  // DWORD
        Style: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern uint SetupRenameErrorA(IntPtr hwndParent, [MarshalAs(UnmanagedType.LPStr)] string DialogTitle, [MarshalAs(UnmanagedType.LPStr)] string SourceFile, [MarshalAs(UnmanagedType.LPStr)] string TargetFile, uint Win32ErrorCode, uint Style);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupRenameErrorA' -Namespace Win32 -PassThru
# $api::SetupRenameErrorA(hwndParent, DialogTitle, SourceFile, TargetFile, Win32ErrorCode, Style)
#uselib "SETUPAPI.dll"
#func global SetupRenameErrorA "SetupRenameErrorA" sptr, sptr, sptr, sptr, sptr, sptr
; SetupRenameErrorA hwndParent, DialogTitle, SourceFile, TargetFile, Win32ErrorCode, Style   ; 戻り値は stat
; hwndParent : HWND -> "sptr"
; DialogTitle : LPCSTR optional -> "sptr"
; SourceFile : LPCSTR -> "sptr"
; TargetFile : LPCSTR -> "sptr"
; Win32ErrorCode : DWORD -> "sptr"
; Style : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupRenameErrorA "SetupRenameErrorA" sptr, str, str, str, int, int
; res = SetupRenameErrorA(hwndParent, DialogTitle, SourceFile, TargetFile, Win32ErrorCode, Style)
; hwndParent : HWND -> "sptr"
; DialogTitle : LPCSTR optional -> "str"
; SourceFile : LPCSTR -> "str"
; TargetFile : LPCSTR -> "str"
; Win32ErrorCode : DWORD -> "int"
; Style : DWORD -> "int"
; DWORD SetupRenameErrorA(HWND hwndParent, LPCSTR DialogTitle, LPCSTR SourceFile, LPCSTR TargetFile, DWORD Win32ErrorCode, DWORD Style)
#uselib "SETUPAPI.dll"
#cfunc global SetupRenameErrorA "SetupRenameErrorA" intptr, str, str, str, int, int
; res = SetupRenameErrorA(hwndParent, DialogTitle, SourceFile, TargetFile, Win32ErrorCode, Style)
; hwndParent : HWND -> "intptr"
; DialogTitle : LPCSTR optional -> "str"
; SourceFile : LPCSTR -> "str"
; TargetFile : LPCSTR -> "str"
; Win32ErrorCode : DWORD -> "int"
; Style : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupRenameErrorA = setupapi.NewProc("SetupRenameErrorA")
)

// hwndParent (HWND), DialogTitle (LPCSTR optional), SourceFile (LPCSTR), TargetFile (LPCSTR), Win32ErrorCode (DWORD), Style (DWORD)
r1, _, err := procSetupRenameErrorA.Call(
	uintptr(hwndParent),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(DialogTitle))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(SourceFile))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(TargetFile))),
	uintptr(Win32ErrorCode),
	uintptr(Style),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SetupRenameErrorA(
  hwndParent: THandle;   // HWND
  DialogTitle: PAnsiChar;   // LPCSTR optional
  SourceFile: PAnsiChar;   // LPCSTR
  TargetFile: PAnsiChar;   // LPCSTR
  Win32ErrorCode: DWORD;   // DWORD
  Style: DWORD   // DWORD
): DWORD; stdcall;
  external 'SETUPAPI.dll' name 'SetupRenameErrorA';
result := DllCall("SETUPAPI\SetupRenameErrorA"
    , "Ptr", hwndParent   ; HWND
    , "AStr", DialogTitle   ; LPCSTR optional
    , "AStr", SourceFile   ; LPCSTR
    , "AStr", TargetFile   ; LPCSTR
    , "UInt", Win32ErrorCode   ; DWORD
    , "UInt", Style   ; DWORD
    , "UInt")   ; return: DWORD
●SetupRenameErrorA(hwndParent, DialogTitle, SourceFile, TargetFile, Win32ErrorCode, Style) = DLL("SETUPAPI.dll", "dword SetupRenameErrorA(void*, char*, char*, char*, dword, dword)")
# 呼び出し: SetupRenameErrorA(hwndParent, DialogTitle, SourceFile, TargetFile, Win32ErrorCode, Style)
# hwndParent : HWND -> "void*"
# DialogTitle : LPCSTR optional -> "char*"
# SourceFile : LPCSTR -> "char*"
# TargetFile : LPCSTR -> "char*"
# Win32ErrorCode : DWORD -> "dword"
# Style : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetupRenameErrorANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Uint32);
typedef SetupRenameErrorADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, int);
final SetupRenameErrorA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupRenameErrorANative, SetupRenameErrorADart>('SetupRenameErrorA');
// hwndParent : HWND -> Pointer<Void>
// DialogTitle : LPCSTR optional -> Pointer<Utf8>
// SourceFile : LPCSTR -> Pointer<Utf8>
// TargetFile : LPCSTR -> Pointer<Utf8>
// Win32ErrorCode : DWORD -> Uint32
// Style : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupRenameErrorA(
  hwndParent: THandle;   // HWND
  DialogTitle: PAnsiChar;   // LPCSTR optional
  SourceFile: PAnsiChar;   // LPCSTR
  TargetFile: PAnsiChar;   // LPCSTR
  Win32ErrorCode: DWORD;   // DWORD
  Style: DWORD   // DWORD
): DWORD; stdcall;
  external 'SETUPAPI.dll' name 'SetupRenameErrorA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupRenameErrorA"
  c_SetupRenameErrorA :: Ptr () -> CString -> CString -> CString -> Word32 -> Word32 -> IO Word32
-- hwndParent : HWND -> Ptr ()
-- DialogTitle : LPCSTR optional -> CString
-- SourceFile : LPCSTR -> CString
-- TargetFile : LPCSTR -> CString
-- Win32ErrorCode : DWORD -> Word32
-- Style : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setuprenameerrora =
  foreign "SetupRenameErrorA"
    ((ptr void) @-> string @-> string @-> string @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hwndParent : HWND -> (ptr void) *)
(* DialogTitle : LPCSTR optional -> string *)
(* SourceFile : LPCSTR -> string *)
(* TargetFile : LPCSTR -> string *)
(* Win32ErrorCode : DWORD -> uint32_t *)
(* Style : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupRenameErrorA" setup-rename-error-a :convention :stdcall) :uint32
  (hwnd-parent :pointer)   ; HWND
  (dialog-title :string)   ; LPCSTR optional
  (source-file :string)   ; LPCSTR
  (target-file :string)   ; LPCSTR
  (win32-error-code :uint32)   ; DWORD
  (style :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupRenameErrorA = Win32::API::More->new('SETUPAPI',
    'DWORD SetupRenameErrorA(HANDLE hwndParent, LPCSTR DialogTitle, LPCSTR SourceFile, LPCSTR TargetFile, DWORD Win32ErrorCode, DWORD Style)');
# my $ret = $SetupRenameErrorA->Call($hwndParent, $DialogTitle, $SourceFile, $TargetFile, $Win32ErrorCode, $Style);
# hwndParent : HWND -> HANDLE
# DialogTitle : LPCSTR optional -> LPCSTR
# SourceFile : LPCSTR -> LPCSTR
# TargetFile : LPCSTR -> LPCSTR
# Win32ErrorCode : DWORD -> DWORD
# Style : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い