fungsi phoneGetMessage (tapi.h)

Artikel
03/04/2024

Fungsi phoneGetMessage mengembalikan pesan TAPI berikutnya yang diantrekan untuk pengiriman ke aplikasi yang menggunakan mekanisme pemberitahuan Penanganan Aktivitas (lihat phoneInitializeEx untuk detail lebih lanjut).

Sintaks

LONG phoneGetMessage(
  HPHONEAPP      hPhoneApp,
  LPPHONEMESSAGE lpMessage,
  DWORD          dwTimeout
);

Parameter

hPhoneApp

Menangani yang dikembalikan oleh phoneInitializeEx. Aplikasi harus mengatur opsi PHONEINITIALIZEEXOPTION_USEEVENT di anggota dwOptions dari struktur PHONEINITIALIZEEXPARAMS .

lpMessage

Penunjuk ke struktur PHONEMESSAGE . Setelah berhasil dikembalikan dari fungsi ini, struktur berisi pesan berikutnya yang telah diantrekan untuk pengiriman ke aplikasi.

dwTimeout

Interval waktu habis, dalam milidetik. Fungsi mengembalikan jika interval berlalu, bahkan jika tidak ada pesan yang dapat dikembalikan. Jika dwTimeout adalah nol, fungsi memeriksa pesan yang diantrekan dan segera kembali. Jika dwTimeout adalah INFINITE, interval waktu habis fungsi tidak pernah berlalu.

Nilai kembali

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

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER, PHONEERR_NOMEM.

Keterangan

Jika fungsi ini telah dipanggil dengan batas waktu bukan nol dan aplikasi memanggil phoneShutdown pada utas lain, fungsi ini segera kembali dengan PHONEERR_INVALAPPHANDLE.

Jika batas waktu kedaluwarsa (atau nol) dan tidak ada pesan yang dapat diambil dari antrean, fungsi akan kembali dengan kesalahan PHONEERR_OPERATIONFAILED.