SetupDiGetHwProfileListExA-Funktion (setupapi.h)

Artikel
11/20/2024

Die SetupDiGetHwProfileListEx--Funktion ruft eine Liste aller aktuell definierten Hardwareprofil-IDs auf einem lokalen oder Remotecomputer ab.

Syntax

WINSETUPAPI BOOL SetupDiGetHwProfileListExA(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

Parameter

[out] HwProfileList

Ein Zeiger auf ein Array, um die Liste der aktuell definierten Hardwareprofil-IDs zu empfangen.

[in] HwProfileListSize

Die Anzahl der DWORDs im HwProfileList Puffers.

[out] RequiredSize

Ein Zeiger auf eine Variable vom Typ DWORD, die die Anzahl der derzeit definierten Hardwareprofile empfängt. Wenn die Zahl größer als HwProfileListSizeist, wird die Liste abgeschnitten, um die Arraygröße anzupassen. Der in RequiredSize zurückgegebene Wert gibt die Erforderliche Arraygröße an, um die gesamte Liste der Hardwareprofile zu speichern.

[out, optional] CurrentlyActiveIndex

Ein Zeiger auf eine Variable, die den Index des derzeit aktiven Hardwareprofils in der abgerufenen Hardwareprofilliste empfängt. Dieser Parameter ist optional und kann NULL-werden.

[in, optional] MachineName

Ein Zeiger auf eine MIT NULL beendete Zeichenfolge, die den Namen eines Remotesystems enthält, für das die Liste der Hardwareprofil-IDs abgerufen werden soll. Dieser Parameter ist optional und kann NULL-werden. Wenn dieser Parameter NULL-ist, wird die Liste für das lokale System abgerufen.

Vorsicht

Die Verwendung dieser Funktion für den Zugriff auf Remotecomputer wird ab Windows 8 und Windows Server 2012 nicht unterstützt, da diese Funktionalität entfernt wurde.

Reserved

Muss NULL-sein.

Rückgabewert

Die Funktion gibt TRUE- zurück, wenn sie erfolgreich ist. Andernfalls wird FALSE- zurückgegeben, und der protokollierte Fehler kann abgerufen werden, indem ein Aufruf an GetLastError-ausgeführt wird. Wenn die erforderliche Größe größer als HwProfileListSizeist, gibt SetupDiGetHwProfileListExFALSE- zurück und ein Aufruf von GetLastError gibt ERROR_INSUFFICIENT_BUFFER zurück.

Bemerkungen

Anmerkung

Der header setupapi.h definiert SetupDiGetHwProfileListEx 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-	Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows.
Zielplattform-	Desktop
Header-	setupapi.h (include Setupapi.h)
Library	Setupapi.lib

Siehe auch

SetupDiGetHwProfileFriendlyNameEx

Freigeben über