IMMDevice::Metode GetId (mmdeviceapi.h)

  • Artikel

Metode GetId mengambil string ID titik akhir yang mengidentifikasi perangkat titik akhir audio.

Sintaks

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

Parameter

[out] ppstrId

Penunjuk ke variabel penunjuk tempat metode menulis alamat string karakter lebar yang dihentikan null yang berisi ID perangkat titik akhir. Metode mengalokasikan penyimpanan untuk string. Pemanggil bertanggung jawab untuk membebaskan penyimpanan, ketika tidak lagi diperlukan, dengan memanggil fungsi CoTaskMemFree . Jika panggilan GetId gagal, *ppstrId adalah NULL. Untuk informasi tentang CoTaskMemFree, lihat dokumentasi Windows SDK.

Menampilkan nilai

Jika metode berhasil, metode akan mengembalikan S_OK. Jika gagal, kemungkinan kode pengembalian menyertakan, tetapi tidak terbatas pada, nilai yang diperlihatkan dalam tabel berikut.

Menampilkan kode Deskripsi
E_OUTOFMEMORY
 Kehabisan memori.
E_POINTER
 Parameter pwstrId adalah NULL.

Keterangan

String ID titik akhir yang diperoleh dari metode ini mengidentifikasi perangkat titik akhir audio yang diwakili oleh instans antarmuka IMMDevice . Klien dapat menggunakan string ID titik akhir untuk membuat instans perangkat titik akhir audio di lain waktu atau dalam proses yang berbeda dengan memanggil metode IMMDeviceEnumerator::GetDevice . Klien harus memperlakukan konten string ID titik akhir sebagai buram. Artinya, klien tidak boleh mencoba mengurai konten string untuk mendapatkan informasi tentang perangkat. Alasannya adalah bahwa format string tidak ditentukan dan mungkin berubah dari satu implementasi modul sistem MMDevice API ke modul berikutnya.

Untuk contoh kode yang memanggil metode GetId , lihat topik berikut:

Persyaratan

   
Klien minimum yang didukung Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2008 [hanya aplikasi desktop]
Target Platform Windows
Header mmdeviceapi.h

Lihat juga

Antarmuka IMMDevice

IMMDeviceEnumerator::GetDevice