faxSetJobA 函数 (winfax.h)

项目
08/27/2023

传真客户端应用程序调用 FaxSetJob 函数以暂停、继续、取消或重启指定的传真作业。

语法

WINFAXAPI BOOL FaxSetJobA(
  [in] HANDLE               FaxHandle,
  [in] DWORD                JobId,
  [in] DWORD                Command,
  [in] const FAX_JOB_ENTRYA *JobEntry
);

参数

[in] FaxHandle

类型： HANDLE

指定通过调用 FaxConnectFaxServer 函数返回的传真服务器句柄。

[in] JobId

类型：DWORD

指定一个 DWORD 变量，该变量是标识要修改的传真作业的唯一数字。调用 FaxEnumJobs 函数以检索在 JobId 参数中使用的有效传真作业标识符。

[in] Command

类型：DWORD

指定指示要执行的作业命令的 DWORD 变量。此参数的取值可为下列值之一：

JC_DELETE

取消指定的传真作业。作业可以是活动作业，也可以是排队作业。

JC_PAUSE

暂停指定的排队传真作业。如果传真作业处于活动状态，传真服务会在作业返回到排队状态时暂停该作业。

JC_RESUME

恢复暂停的传真作业。

JC_RESTART

重启指定的传真作业。

[in] JobEntry

类型： const FAX_JOB_ENTRY*

未使用，必须为 NULL。

返回值

类型： BOOL

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

如果函数失败，则返回值为零。要获得更多的错误信息，请调用 GetLastError。 GetLastError 可能会返回以下错误之一。

返回代码	说明
ERROR_ACCESS_DENIED	拒绝访问。需要FAX_JOB_MANAGE 访问权限。
ERROR_INVALID_PARAMETER	FaxHandle 参数为 NULL，或者一个或所有 Command、JobEntry 或 JobId 参数无效。

注解

应用程序通常调用 FaxSetJob 函数来管理排队的传真作业。若要终止正在进行的传真传输，应用程序可以调用 FaxAbort 函数。

有关详细信息，请参阅修改传真作业和终止传真作业。

注意

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

要求


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