2.2.14 FAX_JOB_PARAM_EXW

The FAX_JOB_PARAM_EXW structure defines information about the new job to create when sending a fax message.

 typedef struct {
   DWORD dwSizeOfStruct;
   DWORD dwScheduleAction;
   SYSTEMTIME tmSchedule;
   DWORD dwReceiptDeliveryType;
   [string] LPWSTR lpwstrReceiptDeliveryAddress;
   FAX_ENUM_PRIORITY_TYPE Priority;
   HCALL hCall;
   DWORD_PTR dwReserved[4];
   [string] LPWSTR lpwstrDocumentName;
   DWORD dwPageCount;
 } FAX_JOB_PARAM_EXW,
  *PFAX_JOB_PARAM_EXW,
  *LPCFAX_JOB_PARAM_EXW;

dwSizeOfStruct: A DWORD ([MS-DTYP] section 2.2.9) that contains the size, in bytes, of this structure. MUST be set to 44 bytes on 32-bit implementations, and MUST be set to 64 bytes on 64-bit implementations.

dwScheduleAction: A DWORD that MUST specify when to send the fax. This member MUST be one of the following values.

Value/code

Meaning

JSA_NOW

0

Send the fax as soon as a device is available.

JSA_SPECIFIC_TIME

1

Send the fax at the time specified by the tmSchedule member.

JSA_DISCOUNT_PERIOD

2

Send the fax during the discount rate period. Call the FAX_GetConfiguration (section 3.1.4.1.36) function to retrieve the discount period for the fax server.

tmSchedule: A SYSTEMTIME ([MS-DTYP] section 2.3.13) structure that contains the date and time to send the fax. The time MUST be specified in UTC. This parameter SHOULD be ignored unless dwScheduleAction is set to 1 (JSA_SPECIFIC_TIME). If the time specified has already passed, the method behaves as if 0 (JSA_NOW) was specified.

dwReceiptDeliveryType: A DWORD that holds the type of receipt delivered to the sender when the fax is successfully sent and when the fax transmission fails. It can also specify if a receipt will be sent for each recipient or for all the recipients together. The value of this parameter MUST be a logical combination of one of the delivery method flags and optionally one of the delivery grouping flags as specified in FAX_ENUM_DELIVERY_REPORT_TYPES (section 2.2.76). The fax client MUST NOT use the DRT_INBOX value if the protocol version reported by the server is FAX_API_VERSION_2 (0x00020000) or FAX_API_VERSION_3 (0x00030000). For more information, see FAX_ConnectFaxServer (section 3.1.4.1.10).

lpwstrReceiptDeliveryAddress: A pointer to a constant, null-terminated character string. If the dwReceiptDeliveryType member contains the DRT_EMAIL or DRT_ATTACH_FAX flag, the string SHOULD be the address to which the delivery receipt (DR) or non-delivery receipt (NDR) SHOULD be sent. If the dwReceiptDeliveryType member is equal to DRT_INBOX, the string SHOULD be the name of the MAPI profile to which the DR or NDR SHOULD be sent. For more information about MAPI, refer to [MSDN-MAPIPRF]. If the dwReceiptDeliveryType member is equal to DRT_MSGBOX, the string SHOULD be the computer name to send the receipt to as a text message containing a character string, as described in Messenger Service Remote Protocol Specification [MS-MSRP] section 3.2.4.1. If the dwReceiptDeliveryType member is set to DRT_NONE, the pointer SHOULD be NULL.

Priority: A value specifying the priority level of the outgoing fax.

hCall: Reserved.

Note  This value MUST be set to NULL.

dwReserved: This field SHOULD be set to zero.

lpwstrDocumentName: A null-terminated character string that holds the document name. A NULL pointer value specifies that no document name is specified for this fax job.

dwPageCount: A DWORD value that holds the number of pages in the fax document pointed to by the lpcwstrFileName parameter of the FAX_SendDocumentEx (section 3.1.4.1.73) method. This value MUST be used only for fax documents in TIFF, which is the only supported format.