SetupGetSourceInfoA-Funktion (setupapi.h)

Artikel
08/26/2023

[Diese Funktion ist für die Verwendung in den betriebssystemen verfügbar, die im Abschnitt "Anforderungen" angegeben sind. Es kann in nachfolgenden Versionen geändert oder entfernt werden. SetupAPI sollte nicht mehr zum Installieren von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Installationsprogrammen für Anwendungen. SetupAPI wird weiterhin zum Installieren von Gerätetreibern verwendet.]

Die SetupGetSourceInfo-Funktion ruft den Pfad, die Tagdatei oder die Medienbeschreibung für eine Quelle ab, die in einer INF-Datei aufgeführt ist.

Syntax

WINSETUPAPI BOOL SetupGetSourceInfoA(
  [in]      HINF   InfHandle,
  [in]      UINT   SourceId,
  [in]      UINT   InfoDesired,
  [in, out] PSTR   ReturnBuffer,
  [in]      DWORD  ReturnBufferSize,
  [in, out] PDWORD RequiredSize
);

Parameter

[in] InfHandle

Handle für eine geöffnete INF-Datei, die einen SourceDisksNames-Abschnitt enthält. Wenn plattformspezifische Abschnitte für das System des Benutzers vorhanden sind (z. B. SourceDisksNames.x86), wird der plattformspezifische Abschnitt verwendet.

[in] SourceId

Bezeichner für ein Quellmedium. Dieser Wert wird verwendet, um im Abschnitt SourceDisksNames nach Schlüssel zu suchen.

[in] InfoDesired

Gibt an, welche Informationen gewünscht werden. Pro Funktionsaufruf kann nur ein Wert angegeben werden, der nicht kombiniert werden kann. Die folgenden Arten von Informationen können aus einem SourceDisksNames-Abschnitt abgerufen werden.

SRCINFO_PATH

Der für die Quelle angegebene Pfad. Dies ist kein vollständiger Pfad, sondern der Pfad relativ zum Installationsstamm.

SRCINFO_TAGFILE

Die Tagdatei, die die Quellmedien identifiziert, oder, wenn Cabinets verwendet werden, den Namen der CABINET-Datei.

SRCINFO_DESCRIPTION

Eine Beschreibung für die Medien.

[in, out] ReturnBuffer

Optionaler Zeiger auf einen Puffer zum Empfangen der abgerufenen Informationen. Pfadrückvorgänge enden garantiert nicht mit . Sie sollten eine NULL-endende Zeichenfolge verwenden. Die NULL-Zeichenfolge darf die Größe des Zielpuffers nicht überschreiten. Sie können die Funktion einmal aufrufen, um die erforderliche Puffergröße abzurufen, den erforderlichen Arbeitsspeicher zuzuweisen und dann die Funktion ein zweites Mal aufzurufen, um die Daten abzurufen. Weitere Informationen finden Sie im Abschnitt mit den Hinweisen. Mit dieser Technik können Sie Fehler vermeiden, die auf eine unzureichende Puffergröße zurückzuführen sind. Dieser Parameter kann NULL sein.

[in] ReturnBufferSize

Größe des Puffers, auf den von ReturnBuffer in Zeichen verwiesen wird. Dies schließt den NULL-Abschlusszeichen ein.

[in, out] RequiredSize

Optionaler Zeiger auf eine Variable, die die erforderliche Größe für den durch ReturnBuffer angegebenen Puffer in Zeichen empfängt. Dies schließt den NULL-Abschlusszeichen ein. Wenn ReturnBuffer angegeben ist und die tatsächliche erforderliche Größe größer als der durch ReturnBufferSize angegebene Wert ist, schlägt die Funktion fehl, und ein Aufruf von GetLastError gibt ERROR_INSUFFICIENT_BUFFER zurück.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Wenn diese Funktion mit einem ReturnBuffer von NULL und einem ReturnBufferSize-Wert von 0 (null) aufgerufen wird, fügt die Funktion die zum Halten der angegebenen Daten erforderliche Puffergröße in die Variable ein, auf die von RequiredSize verwiesen wird. Wenn dies für die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null. Andernfalls ist der Rückgabewert null, und erweiterte Fehlerinformationen können durch Aufrufen von GetLastError abgerufen werden.

Hinweis

Der Setupapi.h-Header definiert SetupGetSourceInfo als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	setupapi.h
Bibliothek	Setupapi.lib
DLL	Setupapi.dll