传真客户端应用程序使用 IFaxServer 双接口来管理与传真服务的连接。 接口检索并设置有关 FaxServer 对象的信息;例如,用于转播、品牌打造、存档和封面的设置;折扣率周期;和传真服务器队列的状态。 IFaxServer 接口包括以下方法:
注意 传真客户端应用程序必须调用 IFaxServer::Connect 方法来启动与活动传真服务器的连接,然后才能访问以 IFax 开头的大多数接口。 (无需传真服务器连接即可访问 IFaxTiff 接口。)
继承
IFaxServer 接口继承自 IDispatch 接口。 IFaxServer 还具有以下类型的成员:
方法
IFaxServer 接口具有以下方法。
IFaxServer::Connect Connect 方法将传真客户端应用程序连接到指定的传真服务器。 |
IFaxServer::CreateDocument IFaxServer::CreateDocument 方法为指定的 FaxServer 对象创建 FaxDoc 对象。 FaxDoc 对象允许用户创建文档并将其传输到一个或多个传真收件人。 |
IFaxServer::D isconnect IFaxServer::D isconnect 方法终止传真客户端应用程序与传真服务器的连接。 |
IFaxServer::get_ArchiveDirectory IFaxServer::get_ArchiveDirectory 方法检索 FaxServer 对象的 ArchiveDirectory 属性。 ArchiveDirectory 属性是一个以 null 结尾的字符串,其中包含传真服务器存储存档的出站传真的位置。 (获取) |
IFaxServer::get_ArchiveOutboundFaxes 设置或检索 FaxServer 对象的 ArchiveOutboundFaxes 属性。 ArchiveOutboundFaxes 属性是一个布尔值,指示传真服务器是否存档传出传真传输。 (获取) |
IFaxServer::get_Branding 设置或检索 FaxServer 对象的 Branding 属性。 Branding 属性是一个布尔值,指示传真服务器是否在传真传输顶部生成品牌信息。 (获取) |
IFaxServer::get_DirtyDays 设置或检索 FaxServer 对象的 DirtyDays 属性。 DirtyDays 属性是传真服务器在传真作业队列中保留未发送作业的天数。 (获取) |
IFaxServer::get_DiscountRateEndHour 设置或检索 FaxServer 对象的 DiscountRateEndHour 属性。 DiscountRateEndHour 属性是一个表示折扣期结束时间的数字。 折扣期仅适用于传出传真传输。 (获取) |
IFaxServer::get_DiscountRateEndMinute 设置或检索 FaxServer 对象的 DiscountRateEndMinute 属性。 DiscountRateEndMinute 属性是一个数字,表示折扣期结束的分钟数。 折扣期仅适用于传出传真传输。 (获取) |
IFaxServer::get_DiscountRateStartHour 设置或检索 FaxServer 对象的 DiscountRateStartHour 属性。 DiscountRateStartHour 属性是一个数字,表示折扣期开始的小时。 折扣期仅适用于传出传真传输。 (获取) |
IFaxServer::get_DiscountRateStartMinute 设置或检索 FaxServer 对象的 DiscountRateStartMinute 属性。 DiscountRateStartMinute 属性是一个数字,表示折扣期开始的分钟数。 折扣期仅适用于传出传真传输。 (获取) |
IFaxServer::get_PauseServerQueue 设置或检索 FaxServer 对象的 PauseServerQueue 属性。 PauseServerQueue 属性是一个布尔值,指示传真服务器是否已暂停传真作业队列。 (获取) |
IFaxServer::get_Retries 设置或检索 FaxServer 对象的 Retries 属性。 Retries 属性是一个值,该值表示传真服务器在初始传输失败时尝试重新传输传出传真的次数。 (获取) |
IFaxServer::get_RetryDelay 设置或检索 FaxServer 对象的 RetryDelay 属性。 RetryDelay 属性是一个值,该值表示传真服务器在尝试重新传输出站传真作业之前等待的时间间隔(以分钟为单位)。 (获取) |
IFaxServer::get_ServerCoverpage 设置或检索 FaxServer 对象的 ServerCoverpage 属性。 ServerCoverpage 属性是一个布尔值,指示传真服务器是否只允许使用通用封面。 (获取) |
IFaxServer::get_ServerMapiProfile 设置或检索 FaxServer 对象的 ServerMapiProfile 属性。 ServerMapiProfile 属性是一个以 null 结尾的字符串,其中包含传真服务器用于路由传入传真传输的 MAPI 用户配置文件。 (获取) |
IFaxServer::get_UseDeviceTsid 设置或检索 FaxServer 对象的 UseDeviceTsid 属性。 UseDeviceTsid 属性是一个布尔值,指示传真服务器是否使用设备的传输站标识符 (TSID) 而不是用户指定的 TSID。 (获取) |
IFaxServer::GetJobs GetJobs 方法为指定的 FaxServer 对象创建并初始化 FaxJobs 对象。 FaxJobs 对象允许枚举连接的传真服务器的当前排队作业。 |
IFaxServer::GetPorts GetPorts 方法为指定的 FaxServer 对象创建并初始化 FaxPorts 对象。 FaxPorts 对象允许枚举连接的传真服务器的传真端口配置信息。 |
IFaxServer::p ut_ArchiveDirectory IFaxServer::get_ArchiveDirectory 方法检索 FaxServer 对象的 ArchiveDirectory 属性。 ArchiveDirectory 属性是一个以 null 结尾的字符串,其中包含传真服务器存储存档的出站传真的位置。 (放置) |
IFaxServer::p ut_ArchiveOutboundFaxes 设置或检索 FaxServer 对象的 ArchiveOutboundFaxes 属性。 ArchiveOutboundFaxes 属性是一个布尔值,指示传真服务器是否存档传出传真传输。 (放置) |
IFaxServer::p ut_Branding 设置或检索 FaxServer 对象的 Branding 属性。 Branding 属性是一个布尔值,指示传真服务器是否在传真传输顶部生成品牌信息。 (放置) |
IFaxServer::p ut_DirtyDays 设置或检索 FaxServer 对象的 DirtyDays 属性。 DirtyDays 属性是传真服务器在传真作业队列中保留未发送作业的天数。 (放置) |
IFaxServer::p ut_DiscountRateEndHour 设置或检索 FaxServer 对象的 DiscountRateEndHour 属性。 DiscountRateEndHour 属性是一个表示折扣期结束时间的数字。 折扣期仅适用于传出传真传输。 (放置) |
IFaxServer::p ut_DiscountRateEndMinute 设置或检索 FaxServer 对象的 DiscountRateEndMinute 属性。 DiscountRateEndMinute 属性是一个数字,表示折扣期结束的分钟数。 折扣期仅适用于传出传真传输。 (放置) |
IFaxServer::p ut_DiscountRateStartHour 设置或检索 FaxServer 对象的 DiscountRateStartHour 属性。 DiscountRateStartHour 属性是一个数字,表示折扣期开始的小时。 折扣期仅适用于传出传真传输。 (放置) |
IFaxServer::p ut_DiscountRateStartMinute 设置或检索 FaxServer 对象的 DiscountRateStartMinute 属性。 DiscountRateStartMinute 属性是一个数字,表示折扣期开始的分钟数。 折扣期仅适用于传出传真传输。 (放置) |
IFaxServer::p ut_PauseServerQueue 设置或检索 FaxServer 对象的 PauseServerQueue 属性。 PauseServerQueue 属性是一个布尔值,指示传真服务器是否已暂停传真作业队列。 (放置) |
IFaxServer::p ut_Retries 设置或检索 FaxServer 对象的 Retries 属性。 Retries 属性是一个值,该值表示传真服务器在初始传输失败时尝试重新传输传出传真的次数。 (放置) |
IFaxServer::p ut_RetryDelay 设置或检索 FaxServer 对象的 RetryDelay 属性。 RetryDelay 属性是一个值,该值表示传真服务器在尝试重新传输出站传真作业之前等待的时间间隔(以分钟为单位)。 (放置) |
IFaxServer::p ut_ServerCoverpage 设置或检索 FaxServer 对象的 ServerCoverpage 属性。 ServerCoverpage 属性是一个布尔值,指示传真服务器是否只允许使用通用封面。 (放置) |
IFaxServer::p ut_ServerMapiProfile 设置或检索 FaxServer 对象的 ServerMapiProfile 属性。 ServerMapiProfile 属性是一个以 null 结尾的字符串,其中包含传真服务器用于路由传入传真传输的 MAPI 用户配置文件。 (放置) |
IFaxServer::p ut_UseDeviceTsid 设置或检索 FaxServer 对象的 UseDeviceTsid 属性。 UseDeviceTsid 属性是一个布尔值,指示传真服务器是否使用设备的传输站标识符 (TSID) 而不是用户指定的 TSID。 (放置) |
备注
何时实现
不应实现此接口。 Microsoft 标准实现提供了完整的功能。何时使用
使用 IFaxServer 接口连接到活动传真服务器并断开其连接。 此外,使用 接口检索和设置 FaxServer 对象的属性,以及创建以下步骤中列出的对象。若要连接到传真服务器并创建其他传真客户端对象,请执行以下步骤:
- 调用 CoCreateInstance 函数以检索指向 IFaxServer 接口的指针并创建 FaxServer 对象的实例。
- 调用 IFaxServer::Connect 方法以启动与活动传真服务器的连接。
- 获取连接后,调用以下方法来创建所需的对象:
- 用于创建 FaxJobs 对象的 IFaxServer::GetJobs 方法。 使用此对象可创建 FaxJob 对象,并枚举与连接的传真服务器关联的传真作业。
- 用于创建 FaxPorts 对象的 IFaxServer::GetPorts 方法。 使用此对象创建 FaxPort 对象,并枚举与传真服务器的连接的传真端口配置信息。
- 用于创建 FaxDoc 对象的 IFaxServer::CreateDocument 方法。 使用此对象传输传真,以及检索和设置 FaxDoc 对象的属性。
- 调用 IFaxServer::D isconnect 方法以断开与传真服务器的连接。
- 为每个对象调用 IUnknown::Release 方法,以允许对象解除分配自身。 如有必要,再次调用 方法以销毁 IFaxPorts 或 IFaxJobs 接口指针。
要求
最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | faxcom.h |