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 abzurufenden Anzeigenamen zugeordnet ist. 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 von Zeichen empfängt, die zum Abrufen des Anzeigenamens erforderlich sind (einschließlich eines NULL-Abschlussators).
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
Rufen Sie SetupDiGetHwProfileFriendlyNameEx auf, um den Anzeigenamen einer Hardwareprofil-ID auf einem Remotecomputer abzurufen.
Hinweis
Der setupapi.h-Header 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 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) | Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows. |
Zielplattform | Desktop |
Kopfzeile | setupapi.h (einschließlich Setupapi.h) |
Bibliothek | Setupapi.lib |