fungsi lineGetDevConfig (tapi.h)

Artikel
03/08/2023

Fungsi lineGetDevConfig mengembalikan objek struktur data "buram", konten yang khusus untuk baris (penyedia layanan) dan kelas perangkat. Objek struktur data menyimpan konfigurasi perangkat aliran media saat ini yang terkait dengan perangkat baris.

Sintaks

LONG lineGetDevConfig(
  DWORD       dwDeviceID,
  LPVARSTRING lpDeviceConfig,
  LPCSTR      lpszDeviceClass
);

Parameter

dwDeviceID

Pengidentifikasi perangkat baris yang akan dikonfigurasi.

lpDeviceConfig

Arahkan ke lokasi memori jenis VARSTRING tempat struktur konfigurasi perangkat dikembalikan. Setelah berhasil menyelesaikan permintaan, lokasi ini diisi dengan konfigurasi perangkat. Anggota dwStringFormat dalam struktur VARSTRING diatur ke STRINGFORMAT_BINARY. Sebelum memanggil lineGetDevConfig, aplikasi harus mengatur anggota dwTotalSize dari struktur ini untuk menunjukkan jumlah memori yang tersedia untuk TAPI untuk mengembalikan informasi.

Catatan Jika parameter ukuran dalam struktur tidak benar, ada kemungkinan data bisa ditimpa. Untuk informasi selengkapnya tentang pengaturan ukuran struktur, lihat topik alokasi memori .

lpszDeviceClass

Penunjuk ke string yang dihentikan null yang menentukan kelas perangkat perangkat yang konfigurasinya diminta. String lineGetID kelas perangkat yang valid sama dengan yang ditentukan untuk fungsi tersebut.

Nilai kembali

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

LINEERR_BADDEVICEID, LINEERR_NODRIVER, LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_UNINITIALIZED, LINEERR_NODEVICE.

Keterangan

Status panggilan spesifik perangkat.

Fungsi lineGetDevConfig dapat digunakan untuk mengambil struktur data dari TAPI yang menentukan konfigurasi perangkat aliran media yang terkait dengan perangkat baris tertentu. Misalnya, konten struktur ini dapat menentukan tingkat data, format karakter, skema modulasi, dan pengaturan protokol kontrol kesalahan untuk perangkat media "datamodem" yang terkait dengan baris.

Biasanya, aplikasi memanggil lineGetID untuk mengidentifikasi perangkat aliran media yang terkait dengan baris, lalu memanggil lineConfigDialog untuk memungkinkan pengguna menyiapkan konfigurasi perangkat. Kemudian dapat memanggil lineGetDevConfig, dan menyimpan informasi konfigurasi dalam buku telepon (atau database lain) yang terkait dengan tujuan panggilan tertentu. Ketika pengguna nantinya ingin memanggil tujuan yang sama lagi, lineSetDevConfig dapat digunakan untuk memulihkan pengaturan konfigurasi yang dipilih oleh pengguna. Fungsi lineSetDevConfig, lineConfigDialog, dan lineGetDevConfig dapat digunakan, dalam urutan tersebut, untuk memungkinkan pengguna melihat dan memperbarui pengaturan.

Format data yang tepat yang terkandung dalam struktur khusus untuk API aliran baris dan media (kelas perangkat), tidak terdokumentasi, dan tidak terdefinis. Struktur yang dikembalikan oleh fungsi ini tidak dapat langsung diakses atau dimanipulasi oleh aplikasi, tetapi hanya dapat disimpan secara utuh dan kemudian digunakan di lineSetDevConfig untuk memulihkan pengaturan. Struktur juga tidak selalu dapat diteruskan ke perangkat lain, bahkan dari kelas perangkat yang sama (meskipun ini dapat berfungsi dalam beberapa instans, itu tidak dijamin).