ホーム › Devices.DeviceAndDriverInstallation › SetupGetInfDriverStoreLocationA

SetupGetInfDriverStoreLocationA

関数

ドライバーストア内のINFファイルの場所を取得する(ANSI)。

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

シグネチャ

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

BOOL SetupGetInfDriverStoreLocationA(
    LPCSTR FileName,
    SP_ALTPLATFORM_INFO_V2* AlternatePlatformInfo,   // optional
    LPCSTR LocaleName,   // optional
    LPSTR ReturnBuffer,
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
FileName	LPCSTR	in	システム INF ファイルディレクトリ内の INF ファイルの名前 (省略可能で完全なディレクトリパスを含む) を格納した、NULL 終端文字列へのポインターです。あるいは、このパラメーターは、ドライバーストア内の INF ファイルの完全修飾ファイル名 (ディレクトリパスとファイル名) を格納した NULL 終端文字列へのポインターです。 INF ファイルの指定方法の詳細については、後述の解説セクションを参照してください。
AlternatePlatformInfo	SP_ALTPLATFORM_INFO_V2*	inoptional	システムでの使用のために予約されています。
LocaleName	LPCSTR	inoptional	システムでの使用のために予約されています。
ReturnBuffer	LPSTR	out	指定された INF ファイルの完全修飾ファイル名を格納する NULL 終端文字列を、この関数が返すバッファーへのポインターです。このパラメーターには NULL を設定できます。サポートされる最大のパスサイズは MAX_PATH です。必要なバッファーのサイズを調べる方法については、後述の解説セクションを参照してください。
ReturnBufferSize	DWORD	in	ReturnBuffer で指定されたバッファーのサイズ (文字数)。
RequiredSize	DWORD*	outoptional	ReturnBuffer バッファーのサイズ (文字数) を受け取る DWORD 型の変数へのポインターです。このパラメーターは省略可能で、NULL を設定できます。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

ドライバーストア内の指定された INF ファイルの完全修飾ファイル名を格納するために必要な戻りバッファーのサイズを調べるには、ReturnBuffer に NULL、ReturnBufferSize に 0 を設定し、RequiredSize を指定して SetupGetInfDriverStoreLocation を呼び出します。SetupGetInfDriverStoreLocation は、必要なバッファーサイズを RequiredSize に返します。

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

SetupGetInfDriverStoreLocation は、FileName で指定された INF ファイルに一致する INF ファイルがドライバーストアに存在する場合、その完全修飾ファイル名を返します。Filename には、システム INF ディレクトリ内の INF ファイルのファイル名 (省略可能でディレクトリパスを含む) を指定する必要があります。あるいは、Filename にはドライバーストア内の INF ファイルの完全修飾ファイル名を指定する必要があります。

たとえば、あるドライバーパッケージの INF ファイルが Myinf.inf であり、このドライバーパッケージに対して、デバイスインストールがシステム INF ディレクトリ C:\Windows\inf に INF ファイル OEM1.inf をインストールしたとします。さらに、デバイスインストールが対応する INF ファイルのコピー C:\windows\system32\driverstore\filerepository\myinf_12345678\myinf.inf をドライバーストアにインストールしたとします。この場合、FileName に OEM1.inf、C:\Windows\inf\OEM1.inf、または C:\windows\system32\driverstore\filerepository\myinf_12345678\myinf.inf のいずれかの文字列を指定すると、関数は C:\windows\system32\driverstore\filerepository\myinf_12345678\myinf.inf を返します。

クラスインストーラーおよびコインストーラーは、SetupGetInfDriverStoreLocation を使用して、ドライバーストアにプレインストールされているドライバーパッケージ内のファイルにアクセスできます。ドライバーストア内のドライバーパッケージのパスを調べるには、インストーラーは次の処理を行います。

SetupDiGetDriverInfoDetail を呼び出して、ドライバーの SP_DRVINFO_DETAIL_DATA 構造体を取得します。この構造体の InfFileName メンバーには、システム INF ディレクトリ内のドライバー INF ファイルの完全修飾ファイル名が格納されています。
SetupGetInfDriverStoreLocation を呼び出し、SetupDiGetDriverInfoDetail の呼び出しで取得したドライバー INF ファイルの完全修飾ファイル名を指定します。SetupGetInfDriverStoreLocation は、ドライバーストア内のドライバー INF ファイルの完全修飾ファイル名を返します。この INF ファイルの完全修飾ファイル名のディレクトリパス部分が、ドライバーパッケージのファイルのパスです。

メモ SetupGetInfDriverStoreLocation は、FileName で指定された INF ファイルの内容を処理しません。この関数を使用して、ドライバーストア内の INF ファイルを内容に基づいて検索することはできません。

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

メモ

setupapi.h ヘッダーは、SetupGetInfDriverStoreLocation を、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 SetupGetInfDriverStoreLocationA(
    LPCSTR FileName,
    SP_ALTPLATFORM_INFO_V2* AlternatePlatformInfo,   // optional
    LPCSTR LocaleName,   // optional
    LPSTR ReturnBuffer,
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetInfDriverStoreLocationA(
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    IntPtr AlternatePlatformInfo,   // SP_ALTPLATFORM_INFO_V2* optional
    [MarshalAs(UnmanagedType.LPStr)] string LocaleName,   // LPCSTR optional
    [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 SetupGetInfDriverStoreLocationA(
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    AlternatePlatformInfo As IntPtr,   ' SP_ALTPLATFORM_INFO_V2* optional
    <MarshalAs(UnmanagedType.LPStr)> LocaleName As String,   ' LPCSTR optional
    <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

' FileName : LPCSTR
' AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
' LocaleName : LPCSTR optional
' ReturnBuffer : LPSTR out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupGetInfDriverStoreLocationA Lib "setupapi" ( _
    ByVal FileName As String, _
    ByVal AlternatePlatformInfo As LongPtr, _
    ByVal LocaleName 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

SetupGetInfDriverStoreLocationA = ctypes.windll.setupapi.SetupGetInfDriverStoreLocationA
SetupGetInfDriverStoreLocationA.restype = wintypes.BOOL
SetupGetInfDriverStoreLocationA.argtypes = [
    wintypes.LPCSTR,  # FileName : LPCSTR
    ctypes.c_void_p,  # AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
    wintypes.LPCSTR,  # LocaleName : LPCSTR optional
    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')
SetupGetInfDriverStoreLocationA = Fiddle::Function.new(
  lib['SetupGetInfDriverStoreLocationA'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
    Fiddle::TYPE_VOIDP,  # LocaleName : LPCSTR optional
    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 SetupGetInfDriverStoreLocationA(
        FileName: *const u8,  // LPCSTR
        AlternatePlatformInfo: *mut SP_ALTPLATFORM_INFO_V2,  // SP_ALTPLATFORM_INFO_V2* optional
        LocaleName: *const u8,  // LPCSTR optional
        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 SetupGetInfDriverStoreLocationA([MarshalAs(UnmanagedType.LPStr)] string FileName, IntPtr AlternatePlatformInfo, [MarshalAs(UnmanagedType.LPStr)] string LocaleName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetInfDriverStoreLocationA' -Namespace Win32 -PassThru
# $api::SetupGetInfDriverStoreLocationA(FileName, AlternatePlatformInfo, LocaleName, ReturnBuffer, ReturnBufferSize, RequiredSize)

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

出力引数:

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