struktur FAX_ROUTE (faxroute.h)

Struktur FAX_ROUTE berisi informasi tentang dokumen faks yang diterima. Layanan faks meneruskan struktur ke metode perutean faks dalam panggilan ke fungsi FaxRouteMethod .

Sintaks

typedef struct _FAX_ROUTE {
  DWORD     SizeOfStruct;
  DWORD     JobId;
  DWORDLONG ElapsedTime;
  DWORDLONG ReceiveTime;
  DWORD     PageCount;
  LPCWSTR   Csid;
  LPCWSTR   Tsid;
  LPCWSTR   CallerId;
  LPCWSTR   RoutingInfo;
  LPCWSTR   ReceiverName;
  LPCWSTR   ReceiverNumber;
  LPCWSTR   DeviceName;
  DWORD     DeviceId;
  LPBYTE    RoutingInfoData;
  DWORD     RoutingInfoDataSize;
} FAX_ROUTE, *PFAX_ROUTE;

Anggota

SizeOfStruct

Jenis: DWORD

Menentukan, dalam byte, ukuran struktur FAX_ROUTE . Sebelum memanggil fungsi FaxRouteMethod , layanan faks mengatur anggota ini ke sizeof(FAX_ROUTE).

JobId

Jenis: DWORD

Menentukan nomor unik yang mengidentifikasi pekerjaan faks yang menerima dokumen faks.

ElapsedTime

Jenis: DWORDLONG

Menentukan bilangan bulat tidak bertanda 64-bit yang merupakan waktu yang berlalu, dalam UTC, untuk pekerjaan faks yang menerima dokumen faks. Parameter ini menunjukkan total waktu yang berlalu antara awal penerimaan faks dan akhir penerimaan faks.

ReceiveTime

Jenis: DWORDLONG

Menentukan bilangan bulat tidak bertanda 64-bit yang merupakan waktu mulai, dalam UTC, untuk pekerjaan faks yang menerima dokumen faks.

PageCount

Jenis: DWORD

Menentukan jumlah halaman dalam dokumen faks yang diterima.

Csid

Jenis: LPCWSTR

Penunjuk ke string karakter Unicode yang dihentikan null konstanta yang menentukan pengidentifikasi stasiun yang disebut perangkat faks lokal yang menerima dokumen faks. Pengidentifikasi ini biasanya merupakan nomor telepon.

Tsid

Jenis: LPCWSTR

Penunjuk ke string karakter Unicode yang dihentikan null konstanta yang menentukan pengidentifikasi stasiun transmisi perangkat faks jarak jauh yang mengirim dokumen faks. Pengidentifikasi ini biasanya merupakan nomor telepon.

CallerId

Jenis: LPCWSTR

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

RoutingInfo

Jenis: LPCWSTR

Penunjuk ke string karakter Unicode yang dihentikan null konstanta yang menentukan string perutean untuk dokumen faks yang diterima. 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.

ReceiverName

Jenis: LPCWSTR

Penunjuk ke string karakter Unicode yang dihentikan null konstanta yang menentukan nama orang yang menerima dokumen faks.

ReceiverNumber

Jenis: LPCWSTR

Penunjuk ke string karakter Unicode yang dihentikan null konstanta yang menentukan nomor telepon perangkat faks yang menerima dokumen faks.

DeviceName

Jenis: LPCWSTR

Penunjuk ke string karakter Unicode yang dihentikan null konstanta yang menentukan nama perangkat yang menerima dokumen faks.

DeviceId

Jenis: DWORD

Menentukan pengidentifikasi baris permanen untuk perangkat faks penerima.

RoutingInfoData

Jenis: LPBYTE

Penunjuk ke buffer yang berisi data perutean tambahan yang ditentukan oleh ekstensi perutean. Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.

RoutingInfoDataSize

Jenis: DWORD

Menentukan ukuran, dalam byte, dari array yang ditujukkan oleh anggota RoutingInfoData .

Keterangan

Metode perutean faks dapat memanggil fungsi panggilan balik FaxRouteModifyRoutingData untuk mengubah informasi perutean untuk metode perutean berikutnya. Fungsi melakukan ini dengan memodifikasi anggota RoutingInfoData dari struktur FAX_ROUTE yang berlaku untuk metode berikutnya. Ini memungkinkan ekstensi perutean faks untuk mengambil data perutean yang ditentukan pengguna dan untuk memberikan informasi panggilan balik tambahan ke metode perutean yang berbeda. Ketika metode perutean berikutnya dijalankan, metode ini memproses transmisi faks yang diterima menggunakan data perutean yang dimodifikasi. Untuk informasi selengkapnya, lihat FaxRouteModifyRoutingData.

Metode perutean faks dapat menggunakan fungsi FileTimeToLocalFileTime , untuk mengonversi dari UTC ke waktu lokal, lalu menggunakan fungsi FileTimeToSystemTime untuk mengonversi waktu lokal ke struktur SYSTEMTIME . SYSTEMTIME berisi anggota individu untuk bulan, hari, tahun, hari kerja, jam, menit, detik, dan milidetik. Lihat MSDN untuk deskripsi fungsi-fungsi ini dan struktur ini.

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	faxroute.h

Lihat juga

Gambaran Umum Antarmuka Pemrograman Aplikasi Ekstensi Perutean Faks

Struktur Ekstensi Perutean Faks

FaxRouteMethod

FaxRouteModifyRoutingData