SetupGetLineTextA-Funktion (setupapi.h)
[Diese Funktion steht für die Verwendung in den im Abschnitt "Anforderungen" angegebenen Betriebssystemen zur Verfügung. Sie kann in nachfolgenden Versionen geändert oder nicht verfügbar sein. SetupAPI sollte nicht mehr für die Installation von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Anwendungsinstallationsprogrammen. SetupAPI wird weiterhin für die Installation von Gerätetreibern verwendet.]
Die SetupGetLineText--Funktion gibt den Inhalt einer Zeile in einer INF-Datei in einer kompakten Form zurück. Die abzurufende Zeile kann durch eine INFCONTEXT- Struktur angegeben werden, die von einer SetupFindLineXXX-Funktion zurückgegeben wird, oder durch explizites Übergeben des INF-Handles, Abschnitts und Schlüssels der gewünschten Zeile.
Syntax
WINSETUPAPI BOOL SetupGetLineTextA(
[in] PINFCONTEXT Context,
[in] HINF InfHandle,
[in] PCSTR Section,
[in] PCSTR Key,
[in, out] PSTR ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
Parameter
[in] Context
Kontext für eine Zeile in einer INF-Datei, deren Text abgerufen werden soll. Dieser Parameter kann NULL-sein. Wenn Context-NULL-ist, müssen InfHandle-, Sectionund Key- angegeben werden.
[in] InfHandle
Behandeln Sie die INF-Datei, die abgefragt werden soll. Dieser Parameter kann NULL-sein. Dieser Parameter wird nur verwendet, wenn Context-NULL-ist. Wenn Context-NULL-ist, müssen InfHandle-, Sectionund Key- angegeben werden.
[in] Section
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Abschnitt angibt, der den Schlüsselnamen der Zeile enthält, deren Text abgerufen werden soll. Dieser Parameter kann NULL-sein. Dieser Parameter wird nur verwendet, wenn Context-NULL-ist. Wenn Context-NULL-ist, müssen InfHandle-, Abschnittund Key- angegeben werden.
[in] Key
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Schlüsselnamen enthält, dessen zugeordnete Zeichenfolge abgerufen werden soll. Dieser Parameter kann NULL-sein. Dieser Parameter wird nur verwendet, wenn Context-NULL-ist. Wenn Context-NULL-ist, müssen InfHandle-, Abschnittund Key- angegeben werden.
[in, out] ReturnBuffer
Wenn nicht NULL-, verweist ReturnBuffer auf einen Puffer, in dem diese Funktion den Inhalt der Zeile zurückgibt. Die null-terminated string 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. Mithilfe dieser Technik können Sie Fehler aufgrund einer unzureichenden Puffergröße vermeiden. Weitere Informationen finden Sie im Abschnitt "Hinweise". Dieser Parameter kann NULL-sein.
[in] ReturnBufferSize
Die Größe des Puffers, auf den der ReturnBuffer Parameter in Zeichen verweist. Dies schließt den null Terminator ein.
[in, out] RequiredSize
Zeigt nicht NULL-auf eine Variable, in der diese Funktion die erforderliche Größe für den Puffer zurückgibt, auf den der ReturnBuffer Parameter in Zeichen verweist. Dies schließt den null Terminator ein. Wenn ReturnBuffer- angegeben ist und die erforderliche Größe größer als der im ReturnBufferSize Parameter angegebene Wert ist, schlägt die Funktion fehl und speichert keine Daten im Puffer.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Wenn diese Funktion mit einem ReturnBuffer- von NULL- und einer ReturnBufferSize- null aufgerufen wird, fügt die Funktion die puffergröße ein, die erforderlich ist, um die angegebenen Daten in die Variable einzuspeichern, auf die RequiredSizeverweist. Wenn die Funktion in diesem Fall erfolgreich ausgeführt wird, ist der Rückgabewert ein Wert ungleich Null. Andernfalls ist der Rückgabewert null und erweiterte Fehlerinformationen können durch Aufrufen von GetLastErrorabgerufen werden.
Diese Funktion gibt den Inhalt einer Zeile in einem kompakten Format zurück. Alle zusätzlichen Leerzeichen werden entfernt, und mehrzeilige Werte werden in eine einzelne zusammenhängende Zeichenfolge konvertiert. Beispiel:
HKLM, , PointerClass0, 1 \
; This is a comment
01, 02, 03
wird zurückgegeben als:
HKLM,,PointerClass0,1,01,02,03
Anmerkung
Der Header setupapi.h definiert SetupGetLineText 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 |
|---|---|
| mindestens unterstützte Client- | Windows XP [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows Server 2003 [Nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | setupapi.h |
| Library | Setupapi.lib |
| DLL- | Setupapi.dll |
| API-Satz | ext-ms-win-setupapi-inf-l1-1-0 (eingeführt in Windows 8) |