Metode IPortableDeviceManager::GetDeviceFriendlyName (portabledeviceapi.h)

  • Artikel

Mengambil nama yang mudah digunakan untuk perangkat.

Sintaks

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

Parameter

[in] pszPnPDeviceID

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

[in, out] pDeviceFriendlyName

Buffer yang dialokasikan penelepon yang digunakan untuk menahan nama yang mudah digunakan untuk perangkat. Untuk mempelajari ukuran yang diperlukan untuk parameter ini, pertama-tama panggil metode ini dengan parameter ini diatur ke NULL dan pcchDeviceFriendlyName diatur ke 0; metode akan berhasil dan mengatur pcchDeviceFriendlyName ke ukuran buffer yang diperlukan untuk menahan nama yang mudah diingat perangkat, termasuk karakter penghentian.

[in, out] pcchDeviceFriendlyName

Pada input, jumlah maksimum karakter yang dapat dipegang pDeviceFriendlyName , termasuk karakter penghentian. Pada output, jumlah karakter yang dikembalikan oleh pDeviceFriendlyName, juga termasuk karakter penghentian.

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 .

Keterangan

Perangkat tidak diperlukan untuk mendukung metode ini. Jika metode ini gagal mengambil nama, coba minta properti WPD_OBJECT_NAME objek perangkat (objek dengan ID WPD_DEVICE_OBJECT_ID).

Persyaratan

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

Lihat juga

Antarmuka IPortableDeviceManager

IPortableDeviceManager::GetDevices