ホーム › System.ProcessStatus › GetDeviceDriverFileNameW

GetDeviceDriverFileNameW

関数

デバイスドライバのファイルパスをUnicodeで取得する。

DLLPSAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// PSAPI.dll  (Unicode / -W)
#include <windows.h>

DWORD GetDeviceDriverFileNameW(
    void* ImageBase,
    LPWSTR lpFilename,
    DWORD nSize
);

パラメーター

名前	型	方向	説明
ImageBase	void*	in	デバイスドライバーのロードアドレス。
lpFilename	LPWSTR	out	デバイスドライバーへのパスを受け取るバッファーへのポインター。
nSize	DWORD	in	lpFilename バッファーのサイズ(文字数)。パスと終端の null 文字を格納できるだけの大きさがバッファーにない場合、文字列は切り詰められます。

戻り値の型: DWORD

公式ドキュメント

指定したデバイスドライバーで利用可能なパスを取得します。(Unicode)

戻り値

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ(終端の null 文字を含まない)を表します。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

Windows 7 および Windows Server 2008 R2 以降、Psapi.h は PSAPI 関数のバージョン番号を定めています。PSAPI のバージョン番号は、関数を呼び出す際に使用する名前と、プログラムがロードしなければならないライブラリに影響します。

PSAPI_VERSION が 2 以上の場合、この関数は Psapi.h で K32GetDeviceDriverFileName として定義され、Kernel32.lib および Kernel32.dll でエクスポートされます。PSAPI_VERSION が 1 の場合、この関数は Psapi.h で GetDeviceDriverFileName として定義され、K32GetDeviceDriverFileName を呼び出すラッパーとして Psapi.lib および Psapi.dll でエクスポートされます。

以前のバージョンの Windows と Windows 7 以降の両方で実行する必要があるプログラムは、常にこの関数を GetDeviceDriverFileName として呼び出してください。シンボルが正しく解決されるようにするには、TARGETLIBS マクロに Psapi.lib を追加し、–DPSAPI_VERSION=1 を指定してプログラムをコンパイルします。実行時の動的リンクを使用するには、Psapi.dll をロードします。

メモ

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

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

各言語での呼び出し定義

// PSAPI.dll  (Unicode / -W)
#include <windows.h>

DWORD GetDeviceDriverFileNameW(
    void* ImageBase,
    LPWSTR lpFilename,
    DWORD nSize
);

[DllImport("PSAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetDeviceDriverFileNameW(
    IntPtr ImageBase,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFilename,   // LPWSTR out
    uint nSize   // DWORD
);

<DllImport("PSAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDeviceDriverFileNameW(
    ImageBase As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> lpFilename As System.Text.StringBuilder,   ' LPWSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function

' ImageBase : void*
' lpFilename : LPWSTR out
' nSize : DWORD
Declare PtrSafe Function GetDeviceDriverFileNameW Lib "psapi" ( _
    ByVal ImageBase As LongPtr, _
    ByVal lpFilename As LongPtr, _
    ByVal nSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDeviceDriverFileNameW = ctypes.windll.psapi.GetDeviceDriverFileNameW
GetDeviceDriverFileNameW.restype = wintypes.DWORD
GetDeviceDriverFileNameW.argtypes = [
    ctypes.POINTER(None),  # ImageBase : void*
    wintypes.LPWSTR,  # lpFilename : LPWSTR out
    wintypes.DWORD,  # nSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PSAPI.dll')
GetDeviceDriverFileNameW = Fiddle::Function.new(
  lib['GetDeviceDriverFileNameW'],
  [
    Fiddle::TYPE_VOIDP,  # ImageBase : void*
    Fiddle::TYPE_VOIDP,  # lpFilename : LPWSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "psapi")]
extern "system" {
    fn GetDeviceDriverFileNameW(
        ImageBase: *mut (),  // void*
        lpFilename: *mut u16,  // LPWSTR out
        nSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PSAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetDeviceDriverFileNameW(IntPtr ImageBase, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFilename, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetDeviceDriverFileNameW' -Namespace Win32 -PassThru
# $api::GetDeviceDriverFileNameW(ImageBase, lpFilename, nSize)

#uselib "PSAPI.dll"
#func global GetDeviceDriverFileNameW "GetDeviceDriverFileNameW" wptr, wptr, wptr
; GetDeviceDriverFileNameW ImageBase, varptr(lpFilename), nSize   ; 戻り値は stat
; ImageBase : void* -> "wptr"
; lpFilename : LPWSTR out -> "wptr"
; nSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "PSAPI.dll"
#cfunc global GetDeviceDriverFileNameW "GetDeviceDriverFileNameW" sptr, var, int
; res = GetDeviceDriverFileNameW(ImageBase, lpFilename, nSize)
; ImageBase : void* -> "sptr"
; lpFilename : LPWSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "PSAPI.dll"
#cfunc global GetDeviceDriverFileNameW "GetDeviceDriverFileNameW" sptr, sptr, int
; res = GetDeviceDriverFileNameW(ImageBase, varptr(lpFilename), nSize)
; ImageBase : void* -> "sptr"
; lpFilename : LPWSTR out -> "sptr"
; nSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。