Metode IPortableDeviceManager::GetDeviceDescription (portabledeviceapi.h)

  • Artikel

Mengambil deskripsi perangkat.

Sintaks

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

Parameter

[in] pszPnPDeviceID

Penunjuk ke string yang dihentikan null yang berisi ID Plug and Play perangkat. Anda dapat mengambil daftar nama Plug and Play perangkat yang saat ini terhubung dengan memanggil GetDevices.

[in, out] pDeviceDescription

Buffer yang dialokasikan penelepon untuk menyimpan nama deskripsi pengguna perangkat. Pemanggil harus mengalokasikan memori untuk parameter ini. Untuk mempelajari ukuran yang diperlukan untuk parameter ini, pertama-tama panggil metode ini dengan parameter ini diatur ke NULL dan pcchDeviceDescription diatur ke 0; metode akan berhasil dan mengatur pcchDeviceDescription ke ukuran buffer yang diperlukan untuk menahan nama yang mudah diingat perangkat, termasuk karakter penghentian.

[in, out] pcchDeviceDescription

Jumlah karakter (tidak termasuk karakter penghentian) dalam pDeviceDescription. Pada input, panjang maksimum pDeviceDescription; pada output, panjang string yang dikembalikan dalam pDeviceDescription.

Nilai kembali

Metode mengembalikan HRESULT. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut.

Menampilkan kode Deskripsi
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)
 Buffer yang disediakan tidak cukup besar untuk menyimpan deskripsi perangkat. (Lihat nilai yang dikembalikan dalam pcchDeviceDescription untuk ukuran yang diperlukan.)
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)
 Deskripsi perangkat tidak dapat ditemukan.
S_OK
 Metode berhasil.
E_POINTER
 Setidaknya salah satu argumen yang diperlukan adalah penunjuk NULL .

Persyaratan

Persyaratan Nilai
Target Platform Windows
Header portabledeviceapi.h
Pustaka PortableDeviceGUIDs.lib

Lihat juga

GetDevices

Antarmuka IPortableDeviceManager