SetupDiGetHwProfileFriendlyNameA-Funktion (setupapi.h)
Die SetupDiGetHwProfileFriendlyName Funktion ruft den Anzeigenamen ab, der einer Hardwareprofil-ID zugeordnet ist.
Syntax
WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameA(
[in] DWORD HwProfile,
[out] PSTR FriendlyName,
[in] DWORD FriendlyNameSize,
[out, optional] PDWORD RequiredSize
);
Parameter
[in] HwProfile
Die Hardwareprofil-ID, die dem anzeigenamen zugeordnet ist, der abgerufen werden soll. Wenn dieser Parameter 0 ist, wird der Anzeigename für das aktuelle Hardwareprofil abgerufen.
[out] FriendlyName
Ein Zeiger auf einen Zeichenfolgenpuffer, um den Anzeigenamen zu erhalten.
[in] FriendlyNameSize
Die Größe des FriendlyName- Puffers in Zeichen.
[out, optional] RequiredSize
Ein Zeiger auf eine Variable vom Typ DWORD, die die Anzahl der Zeichen empfängt, die zum Abrufen des Anzeigenamens erforderlich sind (einschließlich eines NULL-Terminators).
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.
Bemerkungen
Rufen Sie SetupDiGetHwProfileFriendlyNameEx auf, um den Anzeigenamen einer Hardwareprofil-ID auf einem Remotecomputer abzurufen.
Anmerkung
Der header setupapi.h definiert SetupDiGetHwProfileFriendlyName 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 |