ホーム › System.ProcessStatus › K32GetDeviceDriverBaseNameW

K32GetDeviceDriverBaseNameW

関数

デバイスドライバの基本名をUnicode文字列で取得する。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

DWORD K32GetDeviceDriverBaseNameW(
    void* ImageBase,
    LPWSTR lpBaseName,
    DWORD nSize
);

パラメーター

名前	型	方向	説明
ImageBase	void*	in	デバイスドライバーのロードアドレス。この値は EnumDeviceDrivers 関数を使用して取得できます。
lpBaseName	LPWSTR	out	ドライバのベース名(ワイド文字列)を受け取るバッファへのポインタ。出力。
nSize	DWORD	in	lpBaseName バッファーのサイズ (文字数単位)。バッファーがベース名と終端の null 文字を格納するのに十分な大きさでない場合、文字列は切り詰められます。 - lpBaseName [out] デバイスドライバーのベース名を受け取るバッファーへのポインター。

名前

型

方向

説明

ImageBase

void*

デバイスドライバーのロードアドレス。この値は EnumDeviceDrivers 関数を使用して取得できます。

lpBaseName

LPWSTR

out

ドライバのベース名(ワイド文字列)を受け取るバッファへのポインタ。出力。

nSize

DWORD

lpBaseName バッファーのサイズ (文字数単位)。バッファーがベース名と終端の null 文字を格納するのに十分な大きさでない場合、文字列は切り詰められます。

- lpBaseName [out]

デバイスドライバーのベース名を受け取るバッファーへのポインター。

戻り値の型: DWORD

公式ドキュメント

指定したデバイスドライバーのベース名を取得します。(ANSI)

戻り値

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

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

解説(Remarks)

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

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

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

Examples

例については、 Enumerating all Device Drivers in the System を参照してください。

メモ

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

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

各言語での呼び出し定義

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

DWORD K32GetDeviceDriverBaseNameW(
    void* ImageBase,
    LPWSTR lpBaseName,
    DWORD nSize
);

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

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

' ImageBase : void*
' lpBaseName : LPWSTR out
' nSize : DWORD
Declare PtrSafe Function K32GetDeviceDriverBaseNameW Lib "kernel32" ( _
    ByVal ImageBase As LongPtr, _
    ByVal lpBaseName 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

K32GetDeviceDriverBaseNameW = ctypes.windll.kernel32.K32GetDeviceDriverBaseNameW
K32GetDeviceDriverBaseNameW.restype = wintypes.DWORD
K32GetDeviceDriverBaseNameW.argtypes = [
    ctypes.POINTER(None),  # ImageBase : void*
    wintypes.LPWSTR,  # lpBaseName : LPWSTR out
    wintypes.DWORD,  # nSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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