FaxGetDeviceStatusA 函数（winfax.h）

FaxGetDeviceStatus 函数返回传真客户端应用程序当前感兴趣的传真设备状态信息。返回的数据包括其他项目、设备和工作站标识符、发件人和收件人姓名以及路由信息。

语法

WINFAXAPI BOOL FaxGetDeviceStatusA(
  [in]  HANDLE              FaxPortHandle,
  [out] PFAX_DEVICE_STATUSA *DeviceStatus
);

参数

[in] FaxPortHandle

类型：HANDLE

指定通过调用 FaxOpenPort 函数返回的传真端口句柄。

[out] DeviceStatus

类型：PFAX_DEVICE_STATUS*

指向用于接收 FAX_DEVICE_STATUS 结构的缓冲区地址的指针。该结构描述一个传真设备的状态。有关内存分配的信息，请参阅以下“备注”部分

返回值

类型：BOOL

如果函数成功，则返回值为非零。

如果函数失败，则返回值为零。若要获取扩展的错误信息，请调用 GetLastError。 GetLastError 可以返回以下错误之一。

返回代码	描述
ERROR_INVALID_PARAMETER	DeviceStatus 或 FaxPortHandle 参数 NULL。
ERROR_ACCESS_DENIED	访问被拒绝。 FAX_PORT_QUERY 访问是必需的。
ERROR_NOT_ENOUGH_MEMORY	内存分配期间发生错误。

言论

传真管理应用程序通常调用 FaxGetDeviceStatus 函数以显示与传真服务器关联的传真设备的状态。 FaxGetDeviceStatus 函数分配 DeviceStatus 参数指向的 FAX_DEVICE_STATUS 缓冲区所需的内存。应用程序必须调用 FaxFreeBuffer 函数才能解除分配与此参数关联的资源。

有关详细信息，请参阅传真设备管理和释放传真资源。

注意

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

要求

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