FAX_DEVICE_STATUSA结构(winfax.h)

FAX_DEVICE_STATUS 结构包含有关传真设备的当前状态的信息。 除了状态,结构还包括有关设备当前是发送还是接收传真传输、设备和工作站标识符、发件人和收件人姓名以及路由信息的数据。

语法

typedef struct _FAX_DEVICE_STATUSA {
  DWORD    SizeOfStruct;
  LPCSTR   CallerId;
  LPCSTR   Csid;
  DWORD    CurrentPage;
  DWORD    DeviceId;
  LPCSTR   DeviceName;
  LPCSTR   DocumentName;
  DWORD    JobType;
  LPCSTR   PhoneNumber;
  LPCSTR   RoutingString;
  LPCSTR   SenderName;
  LPCSTR   RecipientName;
  DWORD    Size;
  FILETIME StartTime;
  DWORD    Status;
  LPCSTR   StatusString;
  FILETIME SubmittedTime;
  DWORD    TotalPages;
  LPCSTR   Tsid;
  LPCSTR   UserName;
} FAX_DEVICE_STATUSA, *PFAX_DEVICE_STATUSA;

成员

SizeOfStruct

类型:DWORD

指定 FAX_DEVICE_STATUS 结构的大小(以字节为单位)。 传真服务将此成员设置为 sizeof(FAX_DEVICE_STATUS)

CallerId

类型:LPCTSTR

如果 JobType 成员等于 JT_RECEIVE 作业类型,CallerId 是指向标识发送活动传真文档的呼叫设备的空终止的字符串的指针。 此字符串可以包含呼叫设备的电话号码。

Csid

类型:LPCTSTR

指向常量以 null 结尾的字符串的指针,该字符串指定设备的调用工作站标识符。

CurrentPage

类型:DWORD

指定 DWORD 变量,该变量指示传真设备当前正在发送或接收的传真传输中的页数。 页计数相对于一个。

DeviceId

类型:DWORD

指定一个 DWORD 变量,该变量指示感兴趣的传真设备的永久行标识符。

DeviceName

类型:LPCTSTR

指向常量以 null 结尾的字符串的指针,该字符串指定感兴趣的传真设备的名称。

DocumentName

类型:LPCTSTR

指向常量以 null 结尾的字符串的指针,该字符串与设备当前正在发送或接收的传真文档相关联。 这是打印后台处理程序中显示的用户友好名称。

JobType

类型:DWORD

指定一个 DWORD 变量,该变量标识设备上当前处于活动状态的传真作业的类型。 此成员可以是以下作业类型之一。

JT_SEND

传真设备正在发送传真文档。

JT_RECEIVE

传真设备正在接收传真文档。

JT_UNKNOWN

传真设备处于未知或空闲状态。

PhoneNumber

类型:LPCTSTR

如果 JobType 成员等于 JT_SEND 作业类型,PhoneNumber 是指向为传出传真传输拨打的传真号的常数 null 终止的字符串的指针。

RoutingString

类型:LPCTSTR

如果 JobType 成员等于 JT_RECEIVE 作业类型,RoutingString 是指向常量 null 终止的字符串的指针,该字符串指定传入传真的路由字符串。 字符串必须采用以下格式:

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

在 TAPI 文档 地址 主题中定义 (请参阅规范地址子标题): 是规范地址 子地址,并使用子地址格式。

SenderName

类型:LPCTSTR

指向常量以 null 结尾的字符串的指针,该字符串指定发起传真传输的发件人的名称。

RecipientName

类型:LPCTSTR

指向常量以 null 结尾的字符串的指针,该字符串指定传真传输收件人的名称。

Size

类型:DWORD

指定 DWORD 变量,该变量指示活动传真文档的大小(以字节为单位)。

StartTime

类型:FILETIME

指定一个 FILETIME 结构,该结构包含以 UTC 表示的当前传真作业的开始时间。

Status

类型:DWORD

指定 DWORD 变量,该变量是传真设备状态代码或值。 此成员可以是如下所示的预定义设备状态代码之一。

FPS_DIALING

设备正在拨打传真号。

FPS_SENDING

设备正在发送传真文档。

FPS_RECEIVING

设备正在接收传真文档。

FPS_COMPLETED

设备已完成发送或接收传真传输。

FPS_UNAVAILABLE

设备不可用,因为它正在由另一个应用程序使用。

FPS_BUSY

设备遇到繁忙信号。

FPS_NO_ANSWER

接收设备未接听呼叫。

FPS_BAD_ADDRESS

设备拨打了无效的传真号。

FPS_NO_DIAL_TONE

发送设备无法完成呼叫,因为它未检测到拨号音。

FPS_DISCONNECTED

传真呼叫已由发件人或呼叫方断开连接。

FPS_FATAL_ERROR

设备遇到致命协议错误。

FPS_NOT_FAX_CALL

设备已收到数据呼叫或语音呼叫。

FPS_CALL_DELAYED

设备延迟了传真呼叫,因为发送设备多次收到繁忙信号。 设备无法重试呼叫,因为拨号限制存在。 (某些国家/地区限制某个数字正忙时重试次数。

FPS_CALL_BLACKLISTED

设备无法完成呼叫,因为电话号码被阻止或保留;阻止了 911 等数字。

FPS_INITIALIZING

设备正在初始化呼叫。

FPS_OFFLINE

设备处于脱机状态,不可用。

FPS_RINGING

设备正在响铃。

FPS_AVAILABLE

设备可用。

FPS_ABORTING

设备正在中止传真作业。

FPS_ROUTING

设备正在路由收到的传真文档。

FPS_ANSWERED

设备接听了新呼叫。

FPS_HANDLED

传真服务处理了出站传真文档;传真服务提供商将传输文档。

StatusString

类型:LPCTSTR

此成员必须 NULL

SubmittedTime

类型:FILETIME

指定 FILETIME 结构,该结构包含客户端提交传真文档以传输到传真作业队列的时间。 时间以 UTC 表示。

TotalPages

类型:DWORD

指定一个 DWORD 变量,该变量指示传真传输中的页总数。

Tsid

类型:LPCTSTR

指向指定传输站标识符(TSID)的常量以 null 结尾的字符串的指针。 此标识符通常是电话号码。

UserName

类型:LPCTSTR

指向常量以 null 结尾的字符串的指针,该字符串指定提交活动传真作业的用户的名称。

言论

传真客户端应用程序可以调用 FaxGetDeviceStatus 函数来检索感兴趣的传真设备的状态信息。 该函数返回 FAX_DEVICE_STATUS 结构中的信息。

有关详细信息,请参阅 传真设备管理。 有关传真服务提供商为活动传真操作提供的状态信息,请参阅 FAX_DEV_STATUS 主题。

注意

winfax.h 标头将FAX_DEVICE_STATUS定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows 2000 Professional [仅限桌面应用]
支持的最低服务器 Windows 2000 Server [仅限桌面应用]
标头 winfax.h

另请参阅

FILETIME

传真服务客户端 API 结构

适用于 Windows 2000 的 传真服务客户端 API

FaxGetDeviceStatus