fungsi lineGetAppPriority (tapi.h)

Artikel
03/02/2024

Fungsi lineGetAppPriority memungkinkan aplikasi untuk menentukan apakah itu ada dalam daftar prioritas handoff untuk mode media tertentu atau mode permintaan Telepon Terbantu dan, jika demikian, posisinya dalam daftar prioritas.

Sintaks

LONG lineGetAppPriority(
  LPCSTR            lpszAppFilename,
  DWORD             dwMediaMode,
  LPLINEEXTENSIONID lpExtensionID,
  DWORD             dwRequestMode,
  LPVARSTRING       lpExtensionName,
  LPDWORD           lpdwPriority
);

Parameter

lpszAppFilename

Penunjuk ke string yang berisi nama file modul yang dapat dieksekusi aplikasi, tanpa data direktori. Dalam API versi 2.0 atau yang lebih baru, parameter dapat dalam format nama file panjang, di mana format nama file 8.3 adalah subset yang tepat. Nama file panjang, tidak seperti nama file 8.3, mempertahankan kasus. Tidak ada format nama file yang peka huruf besar/kecil. Untuk informasi selengkapnya, lihat Konvensi Nama File. Dalam versi API yang lebih lama dari 2.0, parameter harus menentukan nama file dalam format 8.3; nama file panjang tidak dapat digunakan.

dwMediaMode

Mode media tempat data prioritas akan diperoleh. Nilainya bisa menjadi salah satu konstanta LINEMEDIAMODE_; hanya satu bit yang dapat menyala. Nilai 0 harus digunakan jika memverifikasi prioritas aplikasi untuk permintaan Telepon Terbantu.

lpExtensionID

Penunjuk ke struktur jenis LINEEXTENSIONID. Parameter diabaikan

dwRequestMode

Kondisi untuk parameter ini adalah, jika parameter dwMediaMode adalah nol, parameter ini menentukan mode permintaan Telepon Terbantu yang prioritasnya akan diperiksa. Pasti LINEREQUESTMODE_MAKECALL. Parameter ini diabaikan jika dwMediaMode bukan nol.

lpExtensionName

Parameter diabaikan

lpdwPriority

Pointer ke lokasi memori ukuran DWORD tempat TAPI menulis prioritas aplikasi untuk media atau mode permintaan yang ditentukan. Nilai 0 dikembalikan jika aplikasi tidak berada dalam daftar prioritas tersimpan dan saat ini tidak memiliki perangkat baris yang terbuka dengan kepemilikan yang diminta dari mode media yang ditentukan atau telah mendaftar untuk mode permintaan yang ditentukan.

Dalam versi API yang lebih lama dari 2.0, nilai –1 (0xFFFFFFFF) dikembalikan jika aplikasi membuka baris untuk mode media yang ditentukan atau telah mendaftar untuk permintaan yang ditentukan, tetapi aplikasi tidak ada dalam daftar prioritas tersimpan; artinya, itu hanya dalam daftar prioritas sementara. Di API versi 2.0 atau yang lebih baru, nilai 0 dikembalikan untuk menunjukkan kondisi ini.

Jika tidak, nilai menunjukkan posisi aplikasi dalam daftar; 1 menjadi prioritas tertinggi, dan meningkatkan nilai yang menunjukkan prioritas yang menurun.

Nilai kembali

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

LINEERR_INIFILECORRUPT, LINEERR_INVALREQUESTMODE, LINEERR_INVALAPPNAME, LINEERR_NOMEM, LINEERR_INVALMEDIAMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL.

Keterangan

Jika LINEERR_INVALMEDIAMODE dikembalikan, nilai yang ditentukan dalam dwMediaMode bukan nol, bukan mode media yang diperluas yang valid, dan bukan salah satu konstanta LINEMEDIAMODE_, atau lebih dari satu bit aktif dalam nilai parameter.