ホーム › Devices.DeviceAndDriverInstallation › SetupGetInfPublishedNameW

SetupGetInfPublishedNameW

関数

ドライバーストア内のINFの公開名を取得する(Unicode)。

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

シグネチャ

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

BOOL SetupGetInfPublishedNameW(
    LPCWSTR DriverStoreLocation,
    LPWSTR ReturnBuffer,
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
DriverStoreLocation	LPCWSTR	in	ドライバーストア内の INF ファイルの完全修飾ファイル名 (ディレクトリパスとファイル名) を格納した、NULL で終わる文字列へのポインター。あるいは、システム INF ファイルディレクトリ内の INF ファイルの名前 (および任意でフルディレクトリパス) を格納した、NULL で終わる文字列へのポインターを指定します。INF ファイルの指定方法の詳細については、後述の解説セクションを参照してください。
ReturnBuffer	LPWSTR	out	SetupGetInfPublishedName が、システム INF ディレクトリ内の指定された INF ファイルの完全修飾ファイル名を格納した NULL で終わる文字列を返すバッファーへのポインター。パスの最大サイズは MAX_PATH です。このポインターには NULL を設定できます。戻り値用バッファーに必要なサイズを判断する方法については、後述の解説セクションを参照してください。
ReturnBufferSize	DWORD	in	ReturnBuffer で指定したバッファーのサイズ (文字数単位)。
RequiredSize	DWORD*	outoptional	ReturnBuffer バッファーのサイズ (文字数単位) を受け取る DWORD 型の変数へのポインター。このパラメーターは省略可能で、NULL を設定できます。

戻り値の型: BOOL

公式ドキュメント

SetupGetInfPublishedName 関数は、ドライバーストア内の指定した INF ファイル、またはシステム INF ファイルディレクトリ内の指定した INF ファイルに対応する、システム INF ファイルディレクトリ内の INF ファイルの完全修飾ファイル名 (ディレクトリパスとファイル名) を取得します。(Unicode)

戻り値

SetupGetInfPublishedName が成功した場合、この関数は TRUE を返します。それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。

要求された INF ファイルの完全修飾ファイル名のサイズ (NULL 終端文字を含む文字数) が ReturnBufferSize より大きい場合、この関数は失敗し、GetLastError の呼び出しは ERROR_INSUFFICIENT_BUFFER を返します。

解説(Remarks)

システム INF ディレクトリ内の指定された INF ファイルの完全修飾ファイル名を格納するために必要な戻り値用バッファーのサイズを判断するには、ReturnBuffer に NULL、ReturnBufferSize にゼロを設定し、RequiredSize を指定して SetupGetInfPublishedName を呼び出します。SetupGetInfPublishedName は必要なバッファーサイズを RequiredSize に返します。

デバイスインストールがドライバーパッケージをドライバーストアにプレインストールするとき、ドライバーパッケージの INF ファイルのコピーが 2 つ作成されます。デバイスインストールは、一方のコピーをシステム INF ディレクトリに追加し、その INF ファイルのコピーに OEMnnn.inf 形式の一意の公開ファイル名を割り当てます。デバイスインストールは、INF ファイルの 2 つ目のコピーをドライバーストアに追加し、そのコピーには元の INF ファイル名を割り当てます。

SetupGetInfPublishedName は、DriverStoreLocation で指定された INF ファイルに一致するシステム INF ファイルディレクトリ内の INF ファイルが存在する場合、その完全修飾ファイル名を返します。DriverStoreLocation には、ドライバーストア内の INF ファイルの完全修飾ファイル名を指定するか、システム INF ディレクトリ内の INF ファイルのファイル名 (および任意でディレクトリパス) を指定する必要があります。たとえば、あるドライバーパッケージの INF ファイルが myinf.inf であり、このドライバーパッケージに対してデバイスインストールが INF ファイル OEM1.inf をシステム INF ディレクトリ C:\Windows\inf にインストールしたとします。さらに、デバイスインストールが対応する INF ファイルのコピー C:\windows\system32\driverstore\filerepository\myinf_12345678\myinf.inf をドライバーストアにインストールしたとします。この場合、DriverStoreLocation に次のいずれかの文字列が指定されると、この関数は C:\Windows\inf\OEM1.inf を返します: C:\windows\system32\driverstore\filerepository\myinf_12345678\myinf.inf、OEM1.inf、または C:\Windows\inf\OEM1.inf。

システム INF ファイルディレクトリ内の指定した INF ファイル、またはドライバーストア内の指定したファイルに対応する、ドライバーストア内の INF ファイルの完全修飾ファイル名を取得するには、SetupGetInfDriverStoreLocation 関数を呼び出します。

メモ

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

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

各言語での呼び出し定義

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

BOOL SetupGetInfPublishedNameW(
    LPCWSTR DriverStoreLocation,
    LPWSTR ReturnBuffer,
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetInfPublishedNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string DriverStoreLocation,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ReturnBuffer,   // LPWSTR out
    uint ReturnBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupGetInfPublishedNameW(
    <MarshalAs(UnmanagedType.LPWStr)> DriverStoreLocation As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> ReturnBuffer As System.Text.StringBuilder,   ' LPWSTR out
    ReturnBufferSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' DriverStoreLocation : LPCWSTR
' ReturnBuffer : LPWSTR out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupGetInfPublishedNameW Lib "setupapi" ( _
    ByVal DriverStoreLocation As LongPtr, _
    ByVal ReturnBuffer As LongPtr, _
    ByVal ReturnBufferSize As Long, _
    ByVal RequiredSize As LongPtr) 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

SetupGetInfPublishedNameW = ctypes.windll.setupapi.SetupGetInfPublishedNameW
SetupGetInfPublishedNameW.restype = wintypes.BOOL
SetupGetInfPublishedNameW.argtypes = [
    wintypes.LPCWSTR,  # DriverStoreLocation : LPCWSTR
    wintypes.LPWSTR,  # ReturnBuffer : LPWSTR out
    wintypes.DWORD,  # ReturnBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupGetInfPublishedNameW = Fiddle::Function.new(
  lib['SetupGetInfPublishedNameW'],
  [
    Fiddle::TYPE_VOIDP,  # DriverStoreLocation : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ReturnBuffer : LPWSTR out
    -Fiddle::TYPE_INT,  # ReturnBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "setupapi")]
extern "system" {
    fn SetupGetInfPublishedNameW(
        DriverStoreLocation: *const u16,  // LPCWSTR
        ReturnBuffer: *mut u16,  // LPWSTR out
        ReturnBufferSize: u32,  // DWORD
        RequiredSize: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetupGetInfPublishedNameW([MarshalAs(UnmanagedType.LPWStr)] string DriverStoreLocation, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetInfPublishedNameW' -Namespace Win32 -PassThru
# $api::SetupGetInfPublishedNameW(DriverStoreLocation, ReturnBuffer, ReturnBufferSize, RequiredSize)

#uselib "SETUPAPI.dll"
#func global SetupGetInfPublishedNameW "SetupGetInfPublishedNameW" wptr, wptr, wptr, wptr
; SetupGetInfPublishedNameW DriverStoreLocation, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize)   ; 戻り値は stat
; DriverStoreLocation : LPCWSTR -> "wptr"
; ReturnBuffer : LPWSTR out -> "wptr"
; ReturnBufferSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupGetInfPublishedNameW "SetupGetInfPublishedNameW" wstr, var, int, var
; res = SetupGetInfPublishedNameW(DriverStoreLocation, ReturnBuffer, ReturnBufferSize, RequiredSize)
; DriverStoreLocation : LPCWSTR -> "wstr"
; ReturnBuffer : LPWSTR out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupGetInfPublishedNameW "SetupGetInfPublishedNameW" wstr, sptr, int, sptr
; res = SetupGetInfPublishedNameW(DriverStoreLocation, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize))
; DriverStoreLocation : LPCWSTR -> "wstr"
; ReturnBuffer : LPWSTR out -> "sptr"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。