ホーム › Devices.DeviceAndDriverInstallation › SetupGetInfPublishedNameA

SetupGetInfPublishedNameA

関数

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

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

シグネチャ

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

BOOL SetupGetInfPublishedNameA(
    LPCSTR DriverStoreLocation,
    LPSTR ReturnBuffer,
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
DriverStoreLocation	LPCSTR	in	ドライバーストア内の INF ファイルの完全修飾ファイル名 (ディレクトリパスとファイル名) を格納した NULL 終端文字列へのポインター。または、システム INF ファイルディレクトリ内の INF ファイルの名前 (省略可能で完全なディレクトリパスを含む) を格納した NULL 終端文字列へのポインターを指定します。INF ファイルの指定方法の詳細については、後述の解説のセクションを参照してください。
ReturnBuffer	LPSTR	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 ファイルの完全修飾ファイル名 (ディレクトリパスとファイル名) を取得します。(ANSI)

戻り値

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

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

解説(Remarks)

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

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

SetupGetInfPublishedName は、DriverStoreLocation で指定された INF ファイルに対応する、システム INF ファイルディレクトリ内の INF ファイルの完全修飾ファイル名を返します (対応するものがある場合)。DriverStoreLocation には、ドライバーストア内の INF ファイルの完全修飾ファイル名を指定するか、システム INF ディレクトリ内の INF ファイルのファイル名 (省略可能でディレクトリパスを含む) を指定する必要があります。たとえば、あるドライバーパッケージの INF ファイルが myinf.inf であり、このドライバーパッケージに対してデバイスインストールがシステム INF ディレクトリ C:\Windows\inf に INF ファイル OEM1.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  (ANSI / -A)
#include <windows.h>

BOOL SetupGetInfPublishedNameA(
    LPCSTR DriverStoreLocation,
    LPSTR ReturnBuffer,
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetInfPublishedNameA(
    [MarshalAs(UnmanagedType.LPStr)] string DriverStoreLocation,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ReturnBuffer,   // LPSTR out
    uint ReturnBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

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

' DriverStoreLocation : LPCSTR
' ReturnBuffer : LPSTR out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupGetInfPublishedNameA Lib "setupapi" ( _
    ByVal DriverStoreLocation As String, _
    ByVal ReturnBuffer As String, _
    ByVal ReturnBufferSize As Long, _
    ByVal RequiredSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupGetInfPublishedNameA = ctypes.windll.setupapi.SetupGetInfPublishedNameA
SetupGetInfPublishedNameA.restype = wintypes.BOOL
SetupGetInfPublishedNameA.argtypes = [
    wintypes.LPCSTR,  # DriverStoreLocation : LPCSTR
    wintypes.LPSTR,  # ReturnBuffer : LPSTR 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')
SetupGetInfPublishedNameA = Fiddle::Function.new(
  lib['SetupGetInfPublishedNameA'],
  [
    Fiddle::TYPE_VOIDP,  # DriverStoreLocation : LPCSTR
    Fiddle::TYPE_VOIDP,  # ReturnBuffer : LPSTR out
    -Fiddle::TYPE_INT,  # ReturnBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupGetInfPublishedNameA(
        DriverStoreLocation: *const u8,  // LPCSTR
        ReturnBuffer: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool SetupGetInfPublishedNameA([MarshalAs(UnmanagedType.LPStr)] string DriverStoreLocation, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetInfPublishedNameA' -Namespace Win32 -PassThru
# $api::SetupGetInfPublishedNameA(DriverStoreLocation, ReturnBuffer, ReturnBufferSize, RequiredSize)

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

出力引数:

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