ホーム › Devices.DeviceAndDriverInstallation › DiShowUpdateDevice

DiShowUpdateDevice

関数

デバイスドライバーの更新ウィザードを表示する。

DLLnewdev.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// newdev.dll
#include <windows.h>

BOOL DiShowUpdateDevice(
    HWND hwndParent,   // optional
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,
    DWORD Flags,
    BOOL* NeedReboot   // optional
);

パラメーター

名前	型	方向	説明
hwndParent	HWND	inoptional	指定されたデバイスの更新に関連するユーザーインターフェイス要素を表示するために DiShowUpdateDevice が使用する、最上位ウィンドウへのハンドル。このパラメーターは省略可能で、NULL を設定できます。
DeviceInfoSet	HDEVINFO	in	ハードウェアの更新ウィザードを表示する対象のデバイスを表すデバイス情報要素を含む、デバイス情報セットへのハンドル。
DeviceInfoData	SP_DEVINFO_DATA*	in	ハードウェアの更新ウィザードを表示する対象のデバイスを表す SP_DEVINFO_DATA 構造体へのポインター。
Flags	DWORD	in	このパラメーターにはゼロを設定する必要があります。
NeedReboot	BOOL*	outoptional	ドライバーの更新を完了するためにシステムの再起動が必要かどうかを示すために DiShowUpdateDevice が設定する、BOOL 型の値へのポインター。このパラメーターは省略可能で、NULL を指定できます。このパラメーターが指定され、かつドライバーの更新を完了するためにシステムの再起動が必要な場合、DiShowUpdateDevice は値を TRUE に設定します。この場合、呼び出し元はシステムを再起動するようユーザーに促す必要があります。このパラメーターが指定され、かつインストールを完了するためにシステムの再起動が不要な場合、DiShowUpdateDevice は値を FALSE に設定します。このパラメーターが NULL で、かつドライバーの更新を完了するためにシステムの再起動が必要な場合、DiShowUpdateDevice はシステムの再起動を促すダイアログボックスを表示します。このパラメーターの詳細については、後述の解説セクションを参照してください。

戻り値の型: BOOL

公式ドキュメント

DiShowUpdateDevice 関数は、指定されたデバイスに対するハードウェアの更新ウィザードを表示します。

戻り値

DiShowUpdateDevice は、ハードウェアの更新ウィザードが指定されたデバイスのドライバーを正常に更新した場合に TRUE を返します。それ以外の場合、DiShowUpdateDevice は FALSE を返し、記録されたエラーは GetLastError を呼び出すことで取得できます。GetLastError が返す代表的なエラー値は次のとおりです。

戻り値	説明
ERROR_ACCESS_DENIED	呼び出し元が管理者特権を持っていません。既定では、ドライバーパッケージを更新するために、Windows は呼び出し元プロセスが管理者特権を持つことを要求します。
ERROR_CANCELLED	ユーザーがハードウェアの更新ウィザードをキャンセルしました。
ERROR_IN_WOW64	呼び出し元アプリケーションが 64 ビット環境で実行しようとしている 32 ビットアプリケーションであり、これは許可されていません。詳細については、Installing Devices on 64-Bit Systems を参照してください。
ERROR_INVALID_FLAGS	Flags に指定された値がゼロではありません。

解説(Remarks)

DiShowUpdateDevice は、指定されたデバイスインスタンスに対するハードウェアの更新ウィザードを表示します。ハードウェアの更新ウィザードを使用してデバイスドライバーを更新する方法については、ヘルプとサポートセンターを参照してください。

一般に、インストールアプリケーションは NeedReboot に NULL を設定し、ハードウェアの更新を完了するために再起動が必要な場合にシステムが自動的に再起動を開始するようにしてください。アプリケーションが NeedReboot ポインターを指定すべきなのは、次の場合だけです。

ハードウェアの更新を完了するために、インストールアプリケーションが DiShowUpdateDevice を複数回呼び出す必要がある場合。この場合、アプリケーションは DiShowUpdateDevice のいずれかの呼び出しで NeedReboot に TRUE が返されたかどうかを記録し、返された場合は最後の DiShowUpdateDevice の呼び出しが戻った後にシステムを再起動するようユーザーに促す必要があります。
システムの再起動が行われる前に、DiShowUpdateDevice の呼び出し以外に必要な処理をアプリケーションが実行しなければならない場合。システムの再起動が必要な場合、アプリケーションは必要な処理を完了してから、システムを再起動するようユーザーに促す必要があります。

ハードウェアの更新ウィザードを呼び出す代わりにデバイスのドライバーをロールバックするには、DiRollbackDriver を呼び出します。

ハードウェアの更新ウィザードを呼び出す代わりにデバイスへ新しいドライバーをインストールするには、DiInstallDriver または UpdateDriverForPlugAndPlayDevices を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// newdev.dll
#include <windows.h>

BOOL DiShowUpdateDevice(
    HWND hwndParent,   // optional
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,
    DWORD Flags,
    BOOL* NeedReboot   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("newdev.dll", SetLastError = true, ExactSpelling = true)]
static extern bool DiShowUpdateDevice(
    IntPtr hwndParent,   // HWND optional
    IntPtr DeviceInfoSet,   // HDEVINFO
    IntPtr DeviceInfoData,   // SP_DEVINFO_DATA*
    uint Flags,   // DWORD
    IntPtr NeedReboot   // BOOL* optional, out
);

<DllImport("newdev.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DiShowUpdateDevice(
    hwndParent As IntPtr,   ' HWND optional
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    DeviceInfoData As IntPtr,   ' SP_DEVINFO_DATA*
    Flags As UInteger,   ' DWORD
    NeedReboot As IntPtr   ' BOOL* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwndParent : HWND optional
' DeviceInfoSet : HDEVINFO
' DeviceInfoData : SP_DEVINFO_DATA*
' Flags : DWORD
' NeedReboot : BOOL* optional, out
Declare PtrSafe Function DiShowUpdateDevice Lib "newdev" ( _
    ByVal hwndParent As LongPtr, _
    ByVal DeviceInfoSet As LongPtr, _
    ByVal DeviceInfoData As LongPtr, _
    ByVal Flags As Long, _
    ByVal NeedReboot As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DiShowUpdateDevice = ctypes.windll.newdev.DiShowUpdateDevice
DiShowUpdateDevice.restype = wintypes.BOOL
DiShowUpdateDevice.argtypes = [
    wintypes.HANDLE,  # hwndParent : HWND optional
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    ctypes.c_void_p,  # DeviceInfoData : SP_DEVINFO_DATA*
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # NeedReboot : BOOL* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('newdev.dll')
DiShowUpdateDevice = Fiddle::Function.new(
  lib['DiShowUpdateDevice'],
  [
    Fiddle::TYPE_VOIDP,  # hwndParent : HWND optional
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DeviceInfoData : SP_DEVINFO_DATA*
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # NeedReboot : BOOL* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "newdev")]
extern "system" {
    fn DiShowUpdateDevice(
        hwndParent: *mut core::ffi::c_void,  // HWND optional
        DeviceInfoSet: isize,  // HDEVINFO
        DeviceInfoData: *mut SP_DEVINFO_DATA,  // SP_DEVINFO_DATA*
        Flags: u32,  // DWORD
        NeedReboot: *mut i32  // BOOL* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("newdev.dll", SetLastError = true)]
public static extern bool DiShowUpdateDevice(IntPtr hwndParent, IntPtr DeviceInfoSet, IntPtr DeviceInfoData, uint Flags, IntPtr NeedReboot);
"@
$api = Add-Type -MemberDefinition $sig -Name 'newdev_DiShowUpdateDevice' -Namespace Win32 -PassThru
# $api::DiShowUpdateDevice(hwndParent, DeviceInfoSet, DeviceInfoData, Flags, NeedReboot)

#uselib "newdev.dll"
#func global DiShowUpdateDevice "DiShowUpdateDevice" sptr, sptr, sptr, sptr, sptr
; DiShowUpdateDevice hwndParent, DeviceInfoSet, varptr(DeviceInfoData), Flags, varptr(NeedReboot)   ; 戻り値は stat
; hwndParent : HWND optional -> "sptr"
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "sptr"
; Flags : DWORD -> "sptr"
; NeedReboot : BOOL* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "newdev.dll"
#cfunc global DiShowUpdateDevice "DiShowUpdateDevice" sptr, sptr, var, int, var
; res = DiShowUpdateDevice(hwndParent, DeviceInfoSet, DeviceInfoData, Flags, NeedReboot)
; hwndParent : HWND optional -> "sptr"
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "var"
; Flags : DWORD -> "int"
; NeedReboot : BOOL* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "newdev.dll"
#cfunc global DiShowUpdateDevice "DiShowUpdateDevice" sptr, sptr, sptr, int, sptr
; res = DiShowUpdateDevice(hwndParent, DeviceInfoSet, varptr(DeviceInfoData), Flags, varptr(NeedReboot))
; hwndParent : HWND optional -> "sptr"
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "sptr"
; Flags : DWORD -> "int"
; NeedReboot : BOOL* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。