SetupDiGetHwProfileFriendlyNameExA-Funktion (setupapi.h)

  • Artikel

Die SetupDiGetHwProfileFriendlyNameEx-Funktion ruft den Anzeigenamen ab, der einer Hardwareprofil-ID auf einem lokalen oder Remotecomputer zugeordnet ist.

Syntax

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

Parameter

[in] HwProfile

Stellt die Hardwareprofil-ID bereit, die dem abzurufenden Anzeigenamen zugeordnet ist. Wenn dieser Parameter 0 ist, wird der Anzeigename für das aktuelle Hardwareprofil abgerufen.

[out] FriendlyName

Ein Zeiger auf einen Zeichenpuffer zum Empfangen des Anzeigenamens.

[in] FriendlyNameSize

Die Größe des FriendlyName-Puffers in Zeichen.

[out, optional] RequiredSize

Ein Zeiger auf eine Variable, um die Anzahl von Zeichen zu erhalten, die zum Speichern des Anzeigenamens erforderlich sind (einschließlich eines NULL-Abschlusszeichens). Dieser Parameter ist optional und kann NULL sein.

[in, optional] MachineName

Ein Zeiger auf eine NULL-beendete Zeichenfolge, die den Namen eines Remotecomputers enthält, auf dem sich die Hardwareprofil-ID befindet. Dieser Parameter ist optional und kann NULL sein. Wenn MachineNameNULL ist, befindet sich die Hardwareprofil-ID auf dem lokalen Computer.

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.

Hinweise

Hinweis

Der Setupapi.h-Header definiert SetupDiGetHwProfileFriendlyNameEx als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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

SetupDiGetHwProfileFriendlyName

SetupDiGetHwProfileListEx