SetupGetMultiSzFieldW-Funktion (setupapi.h)

Artikel
03/01/2024

[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 für die Installation von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Anwendungsinstallationsprogrammen. SetupAPI wird weiterhin zum Installieren von Gerätetreibern verwendet.]

Die SetupGetMultiSzField-Funktion ruft mehrere Zeichenfolgen ab, die in einer Zeile einer INF-Datei gespeichert sind, vom angegebenen Feld bis zum Ende der Zeile.

Syntax

WINSETUPAPI BOOL SetupGetMultiSzFieldW(
  [in]      PINFCONTEXT Context,
  [in]      DWORD       FieldIndex,
  [in, out] PWSTR       ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in]      LPDWORD     RequiredSize
);

Parameter

[in] Context

Zeiger auf den Kontext für eine Zeile in einer INF-Datei.

[in] FieldIndex

Der 1-basierte Index des Startfelds innerhalb der angegebenen Zeile, aus der die Zeichenfolgen abgerufen werden sollen. Die Zeichenfolgenliste wird von jedem Feld ab diesem Punkt bis zum Ende der Zeile erstellt. Ein FieldIndex von 0 ist für diese Funktion ungültig.

[in, out] ReturnBuffer

Optionaler Zeiger auf einen Zeichenpuffer, der die Zeichenfolgen empfängt. Jede Zeichenfolge ist null-beendet, mit einem zusätzlichen NULL-Wert am Ende der Zeichenfolgenliste. Die NULL-Zeichenfolge sollte 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 die Funktion dann ein zweites Mal aufzurufen, um die Daten abzurufen. Mit diesem Verfahren können Sie Fehler aufgrund einer unzureichenden Puffergröße vermeiden. Weitere Informationen finden Sie im Abschnitt mit den Hinweisen. Dieser Parameter kann NULL sein.

[in] ReturnBufferSize

Größe des Puffers, auf den returnBuffer in Zeichen verweist. Dies schließt den NULL-Abschlussator ein.

[in] RequiredSize

Optionaler Zeiger auf eine Variable, die die erforderliche Größe für den Puffer empfängt, auf den ReturnBuffer in Zeichen verweist. Dies schließt den NULL-Abschlussator ein. Wenn die 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 Nichtzero-Wert.

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 einer ReturnBufferSize von null aufgerufen wird, legt die Funktion die Puffergröße, die zum Halten der angegebenen Daten erforderlich ist, in die Variable ein, auf die von RequiredSize verwiesen wird. Wenn die Funktion in dieser Funktion erfolgreich ist, ist der Rückgabewert ein Nonzero-Wert. Andernfalls ist der Rückgabewert null, und erweiterte Fehlerinformationen können durch Aufrufen von GetLastError abgerufen werden.

SetupGetMultiSzField sollte nicht zum Durchlaufen von Zeichenfolgenwerten in einer INF-Zeile verwendet werden. Stattdessen sollten Sie SetupGetStringField verwenden. SetupGetMultiSzField gibt einen Wert im Format REG_MULTI_SZ zurück. Dies ist ein Array von NULL-Zeichenfolgen, die durch ein zusätzliches NULL-Zeichen beendet werden. Dieses Format lässt keine Zeichenfolgen der Länge null zu. Wenn die Liste der Zeichenfolgen Zeichenfolgen der Länge null enthält, wird SetupGetMultiSzField vorzeitig zurückgegeben, wenn der erste leere Zeichenfolgenwert angezeigt wird.

Hinweis

Der setupapi.h-Header definiert SetupGetMultiSzField 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 nicht codierungsneutralem Code 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
APIs	ext-ms-win-setupapi-inf-l1-1-1 (eingeführt in Windows 10, Version 10.0.14393)