ホーム › Devices.DeviceAndDriverInstallation › DiUninstallDriverA

DiUninstallDriverA

関数

INFで指定したドライバーパッケージをアンインストールする。

DLLnewdev.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL DiUninstallDriverA(
    HWND hwndParent,   // optional
    LPCSTR InfPath,
    DIUNINSTALLDRIVER_FLAGS Flags,
    BOOL* NeedReboot   // optional
);

パラメーター

名前	型	方向	説明
hwndParent	HWND	inoptional	DiUninstallDriver がドライバーのアンインストールに関連するユーザーインターフェイス要素を表示するために使用する、トップレベルウィンドウへのハンドル。このパラメーターは省略可能であり、NULL を設定できます。
InfPath	LPCSTR	in	ドライバーパッケージの INF ファイルの完全修飾パスを指定する、NULL 終端文字列へのポインター。
Flags	DIUNINSTALLDRIVER_FLAGS	in	DWORD 型の値で、次のフラグのうち 0 個または 1 個以上を指定します: DIURFLAG_NO_REMOVE_INF。通常、このフラグには 0 を設定します。このフラグが 0 の場合、DiUninstallDriver は、ドライバーパッケージがインストールされているすべてのデバイスに対して、一致する別のドライバーパッケージ (利用可能な場合)、または他に一致するドライバーパッケージが無い場合は null ドライバーをインストールすることで、そのドライバーパッケージを削除します。ただし、このフラグに DIURFLAG_NO_REMOVE_INF が設定されている場合、DiUninstallDriver は、ドライバーパッケージがインストールされているすべてのデバイスからそのドライバーパッケージを削除しますが、ドライバーストアからは削除しません。注意: ドライバーパッケージのアンインストールを強制すると、より互換性の高いドライバーパッケージや新しいドライバーパッケージが、互換性の低いドライバーや古いドライバーに置き換えられる可能性があります。 Windows がデバイスのドライバーパッケージを選択する方法については、How Windows Selects Drivers を参照してください。
NeedReboot	BOOL*	outoptional	アンインストールを完了するためにシステムの再起動が必要かどうかを示すために DiUninstallDriver が設定する、BOOL 型の値へのポインター。このパラメーターは省略可能であり、NULL にできます。このパラメーターが指定されていて、アンインストールの完了にシステムの再起動が必要な場合、DiUninstallDriver はこの値を TRUE に設定します。この場合、呼び出し元はシステムを再起動するようユーザーに促す必要があります。このパラメーターが指定されていて、アンインストールの完了にシステムの再起動が不要な場合、DiUninstallDriver はこの値を FALSE に設定します。このパラメーターが NULL で、アンインストールの完了にシステムの再起動が必要な場合、DiUninstallDriver はシステムの再起動を求めるダイアログボックスを表示します。このパラメーターの詳細については、後述の「Remarks」セクションを参照してください。

戻り値の型: BOOL

公式ドキュメント

DiUninstallDriver 関数は、ドライバーパッケージがインストールされているすべてのデバイスに対して、一致する別のドライバーパッケージ (利用可能な場合)、または他に一致するドライバーパッケージが無い場合は null ドライバーをインストールすることで、そのドライバーパッケージを削除します。その後、指定されたドライバーパッケージがドライバーストアから削除されます。(ANSI)

戻り値

DiUninstallDriver は、ドライバーパッケージがインストールされているすべてのデバイスから正常に削除され、かつシステムのドライバーストアからも正常に削除された場合に TRUE を返します。ドライバーパッケージがドライバーストアから正常にアンインストールされなかった場合、DiUninstallDriver は FALSE を返し、記録されたエラーは GetLastError を呼び出すことで取得できます。GetLastError が返す可能性のある比較的一般的なエラー値は次のとおりです。

戻り値	説明
ERROR_ACCESS_DENIED	呼び出し元が Administrator 特権を持っていません。既定では、ドライバーストアからドライバーパッケージをアンインストールするには、呼び出し元が Administrator 特権を持っている必要があります。
ERROR_FILE_NOT_FOUND	指定された INF ファイルのパスが存在しません。
ERROR_INVALID_FLAGS	Flags に指定された値が 0 でも DIURFLAG_NO_REMOVE_INF でもありません。
ERROR_IN_WOW64	呼び出し元のアプリケーションが 32 ビットアプリケーションであり、64 ビット環境で実行しようとしていますが、これは許可されていません。詳細については、Installing Devices on 64-Bit Systems を参照してください。

解説(Remarks)

一般に、アンインストール用アプリケーションでは NeedReboot に NULL を設定し、削除の完了に再起動が必要な場合に DiUninstallDriver がシステムの再起動をユーザーに促すようにするべきです。アプリケーションが NeedReboot ポインターを指定するのは、次の場合のみにするべきです。

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

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

各言語での呼び出し定義

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

BOOL DiUninstallDriverA(
    HWND hwndParent,   // optional
    LPCSTR InfPath,
    DIUNINSTALLDRIVER_FLAGS Flags,
    BOOL* NeedReboot   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("newdev.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool DiUninstallDriverA(
    IntPtr hwndParent,   // HWND optional
    [MarshalAs(UnmanagedType.LPStr)] string InfPath,   // LPCSTR
    uint Flags,   // DIUNINSTALLDRIVER_FLAGS
    IntPtr NeedReboot   // BOOL* optional, out
);

<DllImport("newdev.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DiUninstallDriverA(
    hwndParent As IntPtr,   ' HWND optional
    <MarshalAs(UnmanagedType.LPStr)> InfPath As String,   ' LPCSTR
    Flags As UInteger,   ' DIUNINSTALLDRIVER_FLAGS
    NeedReboot As IntPtr   ' BOOL* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwndParent : HWND optional
' InfPath : LPCSTR
' Flags : DIUNINSTALLDRIVER_FLAGS
' NeedReboot : BOOL* optional, out
Declare PtrSafe Function DiUninstallDriverA Lib "newdev" ( _
    ByVal hwndParent As LongPtr, _
    ByVal InfPath As String, _
    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

DiUninstallDriverA = ctypes.windll.newdev.DiUninstallDriverA
DiUninstallDriverA.restype = wintypes.BOOL
DiUninstallDriverA.argtypes = [
    wintypes.HANDLE,  # hwndParent : HWND optional
    wintypes.LPCSTR,  # InfPath : LPCSTR
    wintypes.DWORD,  # Flags : DIUNINSTALLDRIVER_FLAGS
    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')
DiUninstallDriverA = Fiddle::Function.new(
  lib['DiUninstallDriverA'],
  [
    Fiddle::TYPE_VOIDP,  # hwndParent : HWND optional
    Fiddle::TYPE_VOIDP,  # InfPath : LPCSTR
    -Fiddle::TYPE_INT,  # Flags : DIUNINSTALLDRIVER_FLAGS
    Fiddle::TYPE_VOIDP,  # NeedReboot : BOOL* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "newdev")]
extern "system" {
    fn DiUninstallDriverA(
        hwndParent: *mut core::ffi::c_void,  // HWND optional
        InfPath: *const u8,  // LPCSTR
        Flags: u32,  // DIUNINSTALLDRIVER_FLAGS
        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", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool DiUninstallDriverA(IntPtr hwndParent, [MarshalAs(UnmanagedType.LPStr)] string InfPath, uint Flags, IntPtr NeedReboot);
"@
$api = Add-Type -MemberDefinition $sig -Name 'newdev_DiUninstallDriverA' -Namespace Win32 -PassThru
# $api::DiUninstallDriverA(hwndParent, InfPath, Flags, NeedReboot)

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

出力引数:

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