Freigeben über


IPortableDeviceManager::GetDeviceDescription-Methode (portabledeviceapi.h)

Ruft die Beschreibung eines Geräts ab.

Syntax

HRESULT GetDeviceDescription(
  [in]      LPCWSTR pszPnPDeviceID,
  [in, out] WCHAR   *pDeviceDescription,
  [in, out] DWORD   *pcchDeviceDescription
);

Parameter

[in] pszPnPDeviceID

Zeiger auf eine null-beendete Zeichenfolge, die die Plug & Play-ID des Geräts enthält. Sie können eine Liste mit Plug & Play Namen von Geräten abrufen, die derzeit verbunden sind, indem Sie GetDevices aufrufen.

[in, out] pDeviceDescription

Ein vom Aufrufer zugewiesener Puffer, der den Benutzerbeschreibungsnamen des Geräts enthält. Der Aufrufer muss den Arbeitsspeicher für diesen Parameter zuordnen. Um die erforderliche Größe für diesen Parameter zu ermitteln, rufen Sie zuerst diese Methode auf, wobei dieser Parameter auf NULL und pcchDeviceDescription auf 0 festgelegt ist. die Methode erfolgreich ist, und legen Sie pcchDeviceDescription auf die erforderliche Puffergröße fest, um den gerätefreundlichen Namen zu enthalten, einschließlich des Beendigungszeichens.

[in, out] pcchDeviceDescription

Die Anzahl der Zeichen (ohne das Beendigungszeichen) in pDeviceDescription. Bei Eingabe die maximale Länge von pDeviceDescription; in der Ausgabe die Länge der zurückgegebenen Zeichenfolge in pDeviceDescription.

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 aufzunehmen. (Die erforderliche Größe finden Sie im wert, der in pcchDeviceDescription zurückgegeben wird.)
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)
Die Gerätebeschreibung konnte nicht gefunden werden.
S_OK
Die Methode wurde erfolgreich ausgeführt.
E_POINTER
Mindestens eines der erforderlichen Argumente war ein NULL-Zeiger .

Anforderungen

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

Weitere Informationen

GetDevices

IPortableDeviceManager-Schnittstelle