Metode IAudioSessionControl::SetIconPath (audiopolicy.h)
Metode SetIconPath menetapkan ikon tampilan ke sesi saat ini.
Sintaks
HRESULT SetIconPath(
[in] LPCWSTR Value,
[in] LPCGUID EventContext
);
Parameter
[in] Value
Penunjuk ke string karakter lebar yang dihentikan null yang menentukan jalur dan nama file file .ico, .dll, atau .exe yang berisi ikon. Untuk informasi tentang jalur ikon, lihat dokumentasi Windows SDK.
[in] EventContext
Arahkan ke GUID konteks peristiwa. Jika panggilan ke metode ini menghasilkan peristiwa perubahan ikon, manajer sesi mengirimkan pemberitahuan ke semua klien yang telah mendaftarkan antarmuka IAudioSessionEvents dengan manajer sesi. Manajer sesi menyertakan nilai pointer EventContext dengan setiap pemberitahuan. Setelah menerima pemberitahuan, klien dapat menentukan apakah itu atau klien lain adalah sumber peristiwa dengan memeriksa nilai EventContext . Skema ini tergantung pada klien yang memilih nilai untuk parameter ini yang unik di antara semua klien dalam sesi. Jika penelepon menyediakan pointer NULL untuk parameter ini, metode pemberitahuan klien menerima penunjuk konteks NULL .
Mengembalikan 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 |
|---|---|
|
Nilai Parameter adalah NULL. |
|
Perangkat titik akhir audio telah dicabut, atau perangkat keras audio atau sumber daya perangkat keras terkait telah dikonfigurasi ulang, dinonaktifkan, dihapus, atau dibuat tidak tersedia untuk digunakan. |
|
Layanan audio Windows tidak berjalan. |
Keterangan
Di Windows Vista, program yang disediakan sistem, Sndvol.exe, menggunakan ikon tampilan (bersama dengan nama tampilan) untuk memberi label kontrol volume untuk sesi tersebut. Jika klien tidak memanggil SetIconPath untuk menetapkan ikon ke sesi, program Sndvol menggunakan ikon dari jendela aplikasi sebagai ikon default untuk sesi tersebut.
Dalam kasus sesi lintas proses, sesi tidak dikaitkan dengan satu proses aplikasi. Dengan demikian, Sndvol tidak memiliki ikon khusus aplikasi untuk digunakan secara default, dan klien harus memanggil SetIconPath untuk menghindari menampilkan ikon yang tidak berarti.
Ikon tampilan tidak bertahan melebihi masa pakai objek IAudioSessionControl . Dengan demikian, setelah semua referensi ke objek dirilis, versi objek yang kemudian dibuat (dengan aplikasi yang sama, GUID sesi yang sama, dan perangkat titik akhir yang sama) sekali lagi akan memiliki ikon default sampai klien memanggil SetIconPath.
Klien dapat mengambil ikon tampilan untuk sesi dengan memanggil metode IAudioSessionControl::GetIconPath .
Persyaratan
| Klien minimum yang didukung | Windows Vista [aplikasi desktop | Aplikasi UWP] |
| Server minimum yang didukung | Windows Server 2008 [aplikasi desktop | Aplikasi UWP] |
| Target Platform | Windows |
| Header | audiopolicy.h |