IPortableDeviceManager::GetDeviceFriendlyName-Methode (portabledeviceapi.h)

Artikel
03/01/2024

Ruft den benutzerfreundlichen Namen für das Gerät ab.

Syntax

HRESULT GetDeviceFriendlyName(
  [in]      LPCWSTR pszPnPDeviceID,
  [in, out] WCHAR   *pDeviceFriendlyName,
  [in, out] DWORD   *pcchDeviceFriendlyName
);

Parameter

[in] pszPnPDeviceID

Zeiger auf eine NULL-endende Zeichenfolge, die die Plug & Play-ID des Geräts enthält. Sie können eine Liste mit Plug & Play Namen aller Geräte abrufen, die mit dem Computer verbunden sind, indem Sie GetDevices aufrufen.

[in, out] pDeviceFriendlyName

Ein vom Aufrufer zugewiesener Puffer, der verwendet wird, um den benutzerfreundlichen Namen für das Gerät zu enthalten. Um die erforderliche Größe für diesen Parameter zu ermitteln, rufen Sie zuerst diese Methode auf, wobei dieser Parameter auf NULL und pcchDeviceFriendlyName auf 0 festgelegt ist. Die Methode ist erfolgreich und legt pcchDeviceFriendlyName auf die erforderliche Puffergröße fest, um den Anzeigenamen des Geräts einschließlich des Beendigungszeichens zu enthalten.

[in, out] pcchDeviceFriendlyName

Bei der Eingabe die maximale Anzahl von Zeichen, die pDeviceFriendlyName enthalten kann, einschließlich des Beendigungszeichens. Bei der Ausgabe die Anzahl der Von pDeviceFriendlyName zurückgegebenen Zeichen, einschließlich des Beendigungszeichens.

Rückgabewert

Die Methode gibt ein HRESULT zurück. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.

Rückgabecode	Beschreibung
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	Der bereitgestellte Puffer ist nicht groß genug, um die Gerätebeschreibung zu enthalten. (Die erforderliche Größe finden Sie unter dem in pcchDeviceDescription zurückgegebenen Wert.)
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)	Die Gerätebeschreibung wurde nicht gefunden.
S_OK	Die Methode wurde erfolgreich ausgeführt.
E_POINTER	Mindestens eines der erforderlichen Argumente war ein NULL-Zeiger .

Hinweise

Ein Gerät ist nicht erforderlich, um diese Methode zu unterstützen. Wenn diese Methode einen Namen nicht abrufen kann, versuchen Sie, die WPD_OBJECT_NAME-Eigenschaft des Geräteobjekts (das Objekt mit der ID WPD_DEVICE_OBJECT_ID) anzufordern.

Anforderungen

Anforderung	Wert
Zielplattform	Windows
Kopfzeile	portabledeviceapi.h
Bibliothek	PortableDeviceGUIDs.lib

Weitere Informationen

IPortableDeviceManager-Schnittstelle

IPortableDeviceManager::GetDevices

Freigeben über