fungsi lineGetIcon (tapi.h)

Artikel
03/08/2023

Fungsi lineGetIcon memungkinkan aplikasi untuk mengambil ikon khusus perangkat baris layanan (atau khusus penyedia) untuk ditampilkan kepada pengguna.

Sintaks

LONG lineGetIcon(
  DWORD   dwDeviceID,
  LPCSTR  lpszDeviceClass,
  LPHICON lphIcon
);

Parameter

dwDeviceID

Pengidentifikasi perangkat baris yang ikonnya diminta.

lpszDeviceClass

Penunjuk ke string yang dihentikan null yang mengidentifikasi nama kelas perangkat. Kelas perangkat ini memungkinkan aplikasi untuk memilih sub-ikon tertentu yang berlaku untuk kelas perangkat tersebut. Parameter ini bersifat opsional dan dapat dibiarkan NULL atau kosong, dalam hal ini ikon tingkat tertinggi yang terkait dengan perangkat baris daripada perangkat aliran media tertentu akan dipilih.

lphIcon

Penunjuk ke lokasi memori tempat handel ke ikon dikembalikan.

Nilai kembali

Mengembalikan nol jika permintaan berhasil atau nomor kesalahan negatif jika terjadi kesalahan. Nilai yang mungkin dikembalikan adalah:

LINEERR_BADDEVICEID, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALDEVICECLASS, LINEERR_UNINITIALIZED, LINEERR_NOMEM, LINEERR_NODEVICE.

Keterangan

Fungsi lineGetIcon menyebabkan penyedia mengembalikan handel (di lphIcon) ke sumber daya ikon (diperoleh dari LoadIcon) yang terkait dengan baris yang ditentukan. Handel ikon adalah untuk sumber daya yang terkait dengan penyedia. Aplikasi harus menggunakan CopyIcon jika ingin mereferensikan ikon setelah penyedia dibongkar, yang tidak mungkin terjadi selama aplikasi membuka baris.

Parameter lpszDeviceClass memungkinkan penyedia untuk mengembalikan ikon yang berbeda berdasarkan jenis layanan yang direferensikan oleh pemanggil. String yang diizinkan sama dengan untuk lineGetID. Misalnya, jika baris mendukung Comm API, meneruskan "COMM" sebagai lpszDeviceClass menyebabkan penyedia mengembalikan ikon yang terkait khusus dengan fungsi perangkat Comm penyedia layanan. Parameter "tapi/line", "", atau NULL dapat digunakan untuk meminta ikon untuk layanan baris.

Untuk aplikasi yang menggunakan versi API yang lebih lama dari 2.0, jika penyedia tidak mengembalikan ikon (baik karena kelas perangkat yang diberikan tidak valid atau penyedia tidak mendukung ikon), TAPI menggantikan ikon perangkat baris Telepon generik. Untuk aplikasi yang menggunakan API versi 2.0 atau yang lebih baru, TAPI mengganti ikon baris default hanya jika parameter lpszDeviceClass adalah "tapi/line", "" atau NULL. Untuk kelas perangkat lain, jika kelas perangkat yang diberikan tidak valid atau penyedia tidak mendukung ikon untuk kelas , lineGetIcon mengembalikan LINEERR_INVALDEVICECLASS.