PFAX_RECIPIENT_CALLBACKA回调函数（winfax.h）

项目
11/20/2024

FAX_RECIPIENT_CALLBACK 函数是应用程序定义的或库定义的回调函数，FaxSendDocumentForBroadcast 函数调用以检索传输的用户特定信息。

语法

PFAX_RECIPIENT_CALLBACKA PfaxRecipientCallbacka;

BOOL PfaxRecipientCallbacka(
  [in]                HANDLE FaxHandle,
  [in]                DWORD RecipientNumber,
  [in]                LPVOID Context,
  [in, out]           PFAX_JOB_PARAMA JobParams,
  [in, out, optional] PFAX_COVERPAGE_INFOA CoverpageInfo
)
{...}

参数

[in] FaxHandle

类型：HANDLE

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

[in] RecipientNumber

类型：DWORD

指定 DWORD 变量，该变量指示 FaxSendDocumentForBroadcast 函数调用 FAX_RECIPIENT_CALLBACK 函数的次数。每个函数调用对应于一个指定的传真收件人，索引相对于 1。

[in] Context

类型：LPVOID

指向包含特定于应用程序的上下文信息或应用程序定义的值的变量的指针。 FaxSendDocumentForBroadcast 将此数据传递给 FAX_RECIPIENT_CALLBACK 函数。

[in, out] JobParams

类型：PFAX_JOB_PARAM

指向 FAX_JOB_PARAM 结构的指针，该结构包含传真服务器向指定收件人发送传真传输所需的信息。该结构包括收件人的传真号、发件人和收件人数据、可选的计费代码和作业计划信息等。传真服务器根据 FAX_JOB_PARAM 结构指定的详细信息对传真传输进行排队。

[in, out, optional] CoverpageInfo

类型：PFAX_COVERPAGE_INFO

指向 FAX_COVERPAGE_INFO 结构的指针，该结构包含要显示在指定收件人的传真文档封面上的封面数据。如果不需要封面，则必须 NULL 此参数。

返回值

类型：BOOL

该函数返回非零值，指示 FaxSendDocumentForBroadcast 函数应使用由 JobParams 指向的数据对出站传真传输进行排队，并使用 CoverpageInfo 参数指向的数据。

该函数返回一个值为零，指示不再将传真传输作业排入队列，应终止对 FAX_RECIPIENT_CALLBACK 的调用。若要获取扩展的错误信息，请调用 GetLastError。

言论

FaxSendDocumentForBroadcast 呼叫 FAX_RECIPIENT_CALLBACK 多次，每个指定的传真收件人一次。

PFAX_RECIPIENT_CALLBACK 数据类型是指向 FAX_RECIPIENT_CALLBACK 函数的指针。

在调用 FAX_RECIPIENT_CALLBACK 函数之前调用 FaxCompleteJobParams 函数。 FaxCompleteJobParams 是一个实用工具函数，用于填充 FAX_COVERPAGE_INFO 和 FAX_JOB_PARAM 结构中的多个成员，其中包含发件人的姓名、传真号和可选计费代码信息等信息。

传真客户端应用程序必须在调用 FaxSendDocumentForBroadcast 函数时传递其地址来指定 FAX_RECIPIENT_CALLBACK 函数。

有关详细信息，请参阅传输传真。

注意

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

要求

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