fungsi TSPI_lineGetIcon (tspi.h)

  • Artikel

Fungsi TSPI_lineGetIcon mengambil ikon khusus perangkat baris layanan untuk ditampilkan kepada pengguna.

Sintaks

LONG TSPIAPI TSPI_lineGetIcon(
  DWORD   dwDeviceID,
  LPCWSTR lpszDeviceClass,
  LPHICON lphIcon
);

Parameter

dwDeviceID

Perangkat baris yang ikonnya diminta.

lpszDeviceClass

Penunjuk ke string Unicode yang dihentikan null yang mengidentifikasi nama kelas perangkat. Kelas perangkat ini memungkinkan pemanggil untuk memilih ikon khusus untuk kelas perangkat tersebut. Parameter ini bersifat opsional dan dapat dibiarkan NULL, dalam hal ini ikon tingkat tertinggi yang terkait dengan perangkat baris daripada perangkat aliran media tertentu dipilih.

String yang diizinkan sama dengan untuk TSPI_lineGetID. Misalnya, jika baris mendukung Comm API, melewati comm/datamodem sebagai lpszDeviceClass menyebabkan penyedia mengembalikan ikon yang terkait khusus dengan fungsi perangkat Comm penyedia layanan.

lphIcon

Penunjuk ke lokasi memori tempat handel ke ikon dikembalikan.

Nilai kembali

Mengembalikan nol jika fungsi berhasil, atau angka kesalahan jika terjadi kesalahan. Kemungkinan nilai yang dikembalikan adalah sebagai berikut:

LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_OPERATIONUNAVAIL.

Keterangan

Penyedia harus mengembalikan handel (dalam DWORD yang ditujukan oleh lphIcon) ke sumber daya ikon (diperoleh dari
Fungsi LoadIcon ) yang terkait dengan baris yang ditentukan.

Penyedia dapat memilih untuk mendukung banyak ikon (dipilih oleh lpszDeviceClass dan/atau nomor baris), ikon tunggal (seperti untuk produsen, yang akan dikembalikan untuk semua permintaan TSPI_lineGetIcon terlepas dari lpszDeviceClass yang dipilih), atau tidak ada ikon, dalam hal ini mengatur DWORD yang ditunjukkan oleh lphIcon ke NULL. TAPI memeriksa handel yang dikembalikan oleh penyedia, dan jika penyedia mengembalikan NULL, TAPI mengganti ikon Telepon generik (ikon "garis" generik).

Persyaratan

   
Target Platform Windows
Header tspi.h

Lihat juga

TSPI_lineConfigDialog

TSPI_lineGetID