共用方式為


FAX_DEV_STATUS 結構 (faxdev.h)

FAX_DEV_STATUS結構包含個別作用中傳真作業的狀態和識別資訊。

語法

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;

成員

SizeOfStruct

類型: DWORD

指定 FAX_DEV_STATUS 結構的大小,以位元組為單位。 在回應 FaxDevReportStatus 函式之前,FSP 必須將此成員設定為 sizeof (FAX_DEV_STATUS) 。

StatusId

類型: DWORD

指定傳真狀態代碼或值。 這可以是預先定義的傳真狀態代碼, (如下) 、TAPI LINEERR_常數 錯誤碼或 FSP 所定義的值之一。 如果狀態標識碼是提供者定義的,FSP 也必須提供 StringId 成員的值。 以下是預先定義的傳真狀態代碼。

意義
FS_INITIALIZING 呼叫正在初始化。
FS_DIALING FSP 正在撥入通話的數位。
FS_TRANSMITTING FSP 正在傳輸傳真檔。
FS_RECEIVING FSP 正在接收傳真檔。
FS_COMPLETED 傳真傳輸通話已完成。
FS_LINE_UNAVAILABLE FSP 無法完成呼叫,因為裝置無法使用。
FS_BUSY FSP 收到忙碌訊號。
FS_NO_ANSWER FSP 無法完成呼叫,因為接收裝置未接聽。
FS_BAD_ADDRESS FSP 無法完成呼叫,因為目的地地址無效。
FS_NO_DIAL_TONE FSP 無法完成通話,因為它不會偵測到撥號音。
FS_DISCONNECTED 接聽裝置已中斷呼叫。
FS_FATAL_ERROR 發生嚴重錯誤。
FS_NOT_FAX_CALL 通話是數據通話或語音通話。
FS_CALL_DELAYED FSP 收到忙碌訊號多次。 提供者無法重試,因為撥號限制存在。 (某些國家/地區會限制當數位忙碌時重試次數。)
FS_USER_ABORT FSP 已取消傳輸。 取消可能會導致呼叫 FaxDevAbortOperation函式 。 FSP 也可以提供UI來取消傳真傳輸。
FS_ANSWERED FSP 已接聽輸入呼叫,但尚未收到通話。 此狀態表示電話可能不是傳真電話的傳真服務。
FS_CALL_BLACKLISTED FSP 無法完成通話,因為電話號碼遭到封鎖或保留,例如,對 911 或另一個緊急號碼的通話。

傳真狀態代碼FS_BAD_ADDRESS、FS_CALL_BLACKLISTED和FS_USER_ABORT將不會產生重試嘗試。 傳真狀態代碼FS_LINE_UNAVAILABLE會導致當行無法使用時立即重試,因為服務失去與TAPI傳送LINE_CLOSE的裝置 (連線,而 FSP 回報FS_LINE_UNAVAILABLE) 。 重試取決於裝置是否在在線偵測到。 所有其他傳真狀態代碼都會導致傳真服務管理重試嘗試。

StringId

類型: DWORD

如果 StatusId 是提供者定義的,則指定 StatusId 成員的字串資源識別符。 傳真服務會從 FSP 的影像載入字串。 如果 StatusId 包含提供者定義的狀態代碼或值,則需要此成員。 如果 StatusId 包含預先定義的狀態代碼或值,則會忽略這個成員。

PageCount

類型: DWORD

指定 FSP 正在接收之傳真傳輸中的頁面數目。 頁面計數相對於一個。

CSI

類型: LPWSTR

以 Null 終止的 Unicode 字元字串指標,指定遠端傳真裝置的標識碼,該標識符會與 傳真DevReceiveFaxDevSend 函式目前呼叫連線。

如果作業正在傳送傳真,標識符會指定遠端裝置的 CSID;如果作業收到傳真,標識符會指定遠端裝置的 TSID。

CallerId

類型: LPWSTR

以 Null 終止的 Unicode 字元字串指標,識別傳送已接收傳真檔的呼叫裝置。 此字串可以包含通話裝置的電話號碼。

RoutingInfo

類型: LPWSTR

以 Null 終止的 Unicode 字元字串指標,指定輸入傳真的路由字串。 字串必須是格式:

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

其中 Canonical-Phone-Number 定義於 TAPI 檔的 Address 主題中, (請參閱標準位址子標題) ;而 是 Canonical Address 的子位址,並使用Additional-Routing-Info子位址格式。

針對 DID 路由,將特定的 DID 數位附加至電話號碼前置詞。 DID 位址必須是對應至發件者已撥打的完整電話號碼標準電話號碼。

如果有額外的路由資訊,例如子位址或 DTMF 音調,請以 TAPI 規格中指示的垂直線字元,將它與標準電話號碼分開。 您可以指定多個收件者。

如需詳細資訊,請參閱TAPI檔的Address主題中的可撥號位址和標準位址子標題。

ErrorCode

類型: DWORD

指定 FSP 應該用來報告發生錯誤的其中一個 Win32 系統錯誤碼 [基 底]。 FSP 應該在執行傳真作業正常完成時,將此值設定為NO_ERROR。

Reserved[3]

類型: DWORD

此成員由 Microsoft 保留。 它必須設定為零。

備註

FSP 必須將 FAX_DEV_STATUS 結構的所有成員設定為使用中傳真作業的狀態資訊,或將它們設定為零。

傳真服務會為 CSICallerIdRoutingInfo 成員所指向的字串配置記憶體。 服務配置的記憶體大小等於大小of (FAX_DEV_STATUS) + FAXDEVREPORTSTATUS_SIZE。 FSP 必須將字串放在緊接在 FAX_DEV_STATUS 結構的記憶體區塊中。 CSICallerIdRoutingInfo 成員必須指向記憶體區塊中字串的位置。

規格需求

需求
最低支援的用戶端 Windows 2000 專業版、Windows XP [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 [僅限桌面應用程式]
標頭 faxdev.h

另請參閱

傳真服務提供者結構

FaxDevReceive

FaxDevReportStatus

FaxDevSend

使用傳真服務提供者 API