SetupDiGetHwProfileListExA-Funktion (setupapi.h)

  • Artikel

Die SetupDiGetHwProfileListEx-Funktion ruft eine Liste aller derzeit 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 derzeit definierten Hardwareprofil-IDs zu empfangen.

[in] HwProfileListSize

Die Anzahl der DWORDs im HwProfileList-Puffer .

[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 HwProfileListSize ist, wird die Liste an die Arraygröße angepasst. Der in RequiredSize zurückgegebene Wert gibt die Arraygröße an, die zum Speichern der gesamten Liste der Hardwareprofile erforderlich ist.

[out, optional] CurrentlyActiveIndex

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

[in, optional] MachineName

Ein Zeiger auf eine NULL-endende 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 sein. Wenn dieser Parameter NULL ist, wird die Liste für das lokale System abgerufen.

Achtung

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 durch einen Aufruf von GetLastError abgerufen werden. Wenn die erforderliche Größe größer als HwProfileListSize ist, gibt SetupDiGetHwProfileListExFALSE zurück, und ein Aufruf von GetLastError gibt ERROR_INSUFFICIENT_BUFFER zurück.

Hinweise

Hinweis

Der setupapi.h-Header 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
Unterstützte Mindestversion (Client) Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows.
Zielplattform Desktop
Kopfzeile setupapi.h (schließen Sie Setupapi.h ein)
Bibliothek Setupapi.lib

Weitere Informationen

SetupDiGetHwProfileFriendlyNameEx