struktur FAX_DEV_STATUS (faxdev.h)

Struktur FAX_DEV_STATUS berisi informasi status dan identifikasi tentang operasi faks aktif individu.

Sintaks

typedef struct _FAX_DEV_STATUS {
  DWORD  SizeOfStruct;
  DWORD  StatusId;
  DWORD  StringId;
  DWORD  PageCount;
  LPWSTR CSI;
  LPWSTR CallerId;
  LPWSTR RoutingInfo;
  DWORD  ErrorCode;
  DWORD  Reserved[3];
} FAX_DEV_STATUS, *PFAX_DEV_STATUS;

Anggota

SizeOfStruct

Jenis: DWORD

Menentukan ukuran, dalam byte, dari struktur FAX_DEV_STATUS . Sebelum menanggapi fungsi FaxDevReportStatus , FSP harus mengatur anggota ini ke sizeof(FAX_DEV_STATUS).

StatusId

Jenis: DWORD

Menentukan kode atau nilai status faks. Ini bisa menjadi kode status faks yang telah ditentukan sebelumnya (ditunjukkan berikut), salah satu kode kesalahan TAPI LINEERR_ Konstanta , atau nilai yang ditentukan FSP. Jika pengidentifikasi status ditentukan penyedia, FSP juga harus menyediakan nilai untuk anggota StringId . Berikut ini adalah kode status faks yang telah ditentukan sebelumnya.

Nilai	Makna
FS_INITIALIZING	Panggilan sedang menginisialisasi.
FS_DIALING	FSP memutar nomor untuk panggilan.
FS_TRANSMITTING	FSP mengirimkan dokumen faks.
FS_RECEIVING	FSP menerima dokumen faks.
FS_COMPLETED	Panggilan transmisi faks selesai.
FS_LINE_UNAVAILABLE	FSP tidak dapat menyelesaikan panggilan karena perangkat tidak tersedia.
FS_BUSY	FSP menerima sinyal sibuk.
FS_NO_ANSWER	FSP tidak dapat menyelesaikan panggilan karena perangkat penerima tidak menjawab.
FS_BAD_ADDRESS	FSP tidak dapat menyelesaikan panggilan karena alamat tujuan tidak valid.
FS_NO_DIAL_TONE	FSP tidak dapat menyelesaikan panggilan karena tidak mendeteksi nada putar nomor.
FS_DISCONNECTED	Panggilan terputus oleh perangkat penerima.
FS_FATAL_ERROR	Terjadi kesalahan fatal.
FS_NOT_FAX_CALL	Panggilan adalah panggilan data atau panggilan suara.
FS_CALL_DELAYED	FSP menerima sinyal sibuk beberapa kali. Penyedia tidak dapat mencoba kembali karena pembatasan putar nomor ada. (Beberapa negara/wilayah membatasi jumlah percobaan ulang saat angka sibuk.)
FS_USER_ABORT	FSP telah membatalkan transmisi. Pembatalan dapat dihasilkan dari panggilan ke fungsi FaxDevAbortOperation . FSP juga dapat menyediakan UI untuk pembatalan transmisi faks.
FS_ANSWERED	FSP menjawab panggilan masuk tetapi belum menerima panggilan. Status ini menunjukkan ke layanan faks bahwa panggilan mungkin bukan panggilan faks.
FS_CALL_BLACKLISTED	FSP tidak dapat menyelesaikan panggilan karena nomor telepon diblokir atau dicadangkan, misalnya, panggilan ke 911 atau nomor darurat lainnya.

Kode status faks FS_BAD_ADDRESS, FS_CALL_BLACKLISTED, dan FS_USER_ABORT tidak akan menghasilkan upaya coba lagi. Kode status faks FS_LINE_UNAVAILABLE akan mengakibatkan upaya coba lagi segera dalam kasus ketika baris tidak tersedia karena layanan kehilangan koneksi ke perangkat (TAPI yang dikirim LINE_CLOSE, dan FSP melaporkan FS_LINE_UNAVAILABLE). Coba lagi tergantung pada apakah perangkat terdeteksi kembali online. Semua kode status faks lainnya akan mengakibatkan memungkinkan layanan faks mengelola upaya coba lagi.

StringId

Jenis: DWORD

Menentukan pengidentifikasi sumber daya string untuk anggota StatusId jika StatusId ditentukan penyedia. Layanan faks memuat string dari gambar FSP. Jika StatusId berisi kode status atau nilai yang ditentukan penyedia, anggota ini diperlukan. Jika StatusId berisi kode status atau nilai yang telah ditentukan sebelumnya, anggota ini diabaikan.

PageCount

Jenis: DWORD

Menentukan jumlah halaman dalam transmisi faks yang diterima FSP. Jumlah halaman relatif terhadap satu.

CSI

Jenis: LPWSTR

Penunjuk ke string karakter Unicode yang dihentikan null yang menentukan pengidentifikasi perangkat faks jarak jauh yang terhubung dengan panggilan saat ini ke fungsi FaxDevReceive atau FaxDevSend .

Jika operasi mengirim faks, pengidentifikasi menentukan CSID perangkat jarak jauh; jika operasi menerima faks, pengidentifikasi menentukan TSID perangkat jarak jauh.

CallerId

Jenis: LPWSTR

Penunjuk ke string karakter Unicode yang dihentikan null yang mengidentifikasi perangkat panggilan yang mengirim dokumen faks yang diterima. String ini dapat mencakup nomor telepon perangkat panggilan.

RoutingInfo

Jenis: LPWSTR

Penunjuk ke string karakter Unicode yang dihentikan null yang menentukan string perutean untuk faks masuk. String harus dalam bentuk:

Canonical-Phone-Number[|Additional-Routing-Info]

di mana Canonical-Phone-Number didefinisikan dalam topik Alamat dokumentasi TAPI (lihat subjudul Alamat Kanonis); dan Additional-Routing-Info merupakan subaddress dari Alamat Kanonis, dan menggunakan format subaddress.

Untuk perutean DID, tambahkan digit DID tertentu ke awalan nomor telepon. Alamat DID harus berupa nomor telepon kanonis yang sesuai dengan nomor telepon yang sepenuhnya memenuhi syarat yang akan dihubungi pengirim.

Jika ada informasi perutean tambahan, misalnya, subaddressing atau nada DTMF, pisahkan dari nomor telepon kanonis dengan karakter bilah vertikal seperti yang ditunjukkan dalam spesifikasi TAPI. Anda dapat menentukan beberapa penerima.

Untuk informasi selengkapnya, lihat subjudul Alamat Dapat Dialable dan Alamat Kanonis dalam topik Alamat dokumentasi TAPI.

ErrorCode

Jenis: DWORD

Menentukan salah satu Kode Kesalahan Sistem Win32 [Basis] yang harus digunakan FSP untuk melaporkan kesalahan yang terjadi. FSP harus mengatur nilai ini ke NO_ERROR saat berjalan dan setelah pekerjaan faks selesai secara normal.

Reserved[3]

Jenis: DWORD

Anggota ini dicadangkan oleh Microsoft. Ini harus diatur ke nol.

Keterangan

FSP harus mengatur semua anggota struktur FAX_DEV_STATUS ke informasi status untuk operasi faks aktif, atau mengaturnya ke nol.

Layanan faks mengalokasikan memori untuk string yang diarahkan oleh anggota CSI, CallerId , dan RoutingInfo . Ukuran memori yang dialokasikan layanan sama dengan sizeof(FAX_DEV_STATUS) + FAXDEVREPORTSTATUS_SIZE. FSP harus menempatkan string di blok memori yang segera mengikuti struktur FAX_DEV_STATUS . Anggota CSI, CallerId , dan RoutingInfo harus menunjuk ke lokasi string di blok memori.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional, Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Header	faxdev.h

Lihat juga

Struktur Penyedia Layanan Faks

FaxDevReceive

FaxDevReportStatus

FaxDevSend

Menggunakan API Penyedia Layanan Faks