The FAX_JOB_PARAMW structure contains information about a fax job, including information about the personal profiles (section 3.1.1) for the sender and the recipient of the fax. This structure is used as an input argument for the FaxObs_SendDocument (section 3.1.4.2.7) method.
typedef struct {
DWORD SizeOfStruct;
[string] LPCWSTR RecipientNumber;
[string] LPCWSTR RecipientName;
[string] LPCWSTR Tsid;
[string] LPCWSTR SenderName;
[string] LPCWSTR SenderCompany;
[string] LPCWSTR SenderDept;
[string] LPCWSTR BillingCode;
DWORD ScheduleAction;
SYSTEMTIME ScheduleTime;
DWORD DeliveryReportType;
[string] LPCWSTR DeliveryReportAddress;
[string] LPCWSTR DocumentName;
HCALL CallHandle;
DWORD_PTR Reserved[3];
} FAX_JOB_PARAMW,
*PFAX_JOB_PARAMW;
SizeOfStruct: A DWORD ([MS-DTYP] section 2.2.9) that contains the size, in bytes, of this structure. This value MUST be 80 or 136 bytes. When filled in on a 32-bit implementation, this value SHOULD be 80 bytes. When filled in on a 64-bit implementation, this value SHOULD be 136 bytes.
RecipientNumber: A null-terminated character string that holds the fax number of the fax transmission recipient.
RecipientName: A null-terminated character string that holds the name of the fax transmission recipient.
Tsid: A null-terminated character string that holds the transmitting subscriber identifier (TSID). The valid characters for a TSID string are the English letters, the numeric symbols, and the punctuation marks (ASCII range 0x20 to 0x7F).
SenderName: A null-terminated character string that holds the name of the fax transmission sender.
SenderCompany: A null-terminated character string that holds the name of the fax transmission sender's company.
SenderDept: A null-terminated character string that holds the name of the fax transmission sender's department.
BillingCode: A null-terminated character string that holds an optional billing code for the fax transmission.
ScheduleAction: A DWORD variable that indicates when the fax is to be sent. This value can be one of the following values:
|
Value/code |
Meaning |
|---|---|
|
JSA_NOW 0x00000000 |
The fax is to be sent as soon as a fax device is available. |
|
JSA_SPECIFIC_TIME 0x00000001 |
The fax is to be sent at the time specified by the ScheduleTime member of this structure. |
|
JSA_DISCOUNT_PERIOD 0x00000002 |
The fax is to be sent during the discount rate period. The FaxObs_GetConfiguration (section 3.1.4.2.24) method can be called to retrieve the discount period for the fax server. |
ScheduleTime: A SYSTEMTIME ([MS-DTYP] section 2.3.13) structure indicating the local date and time to send the fax, in UTC format. This member is used when the ScheduleAction member is set to 0x00000001 (JSA_SPECIFIC_TIME), and is otherwise ignored.
DeliveryReportType: A DWORD variable that indicates the fax delivery report type. This value can be one of the FAX_ENUM_DELIVERY_REPORT_TYPES (section 2.2.76) enumeration values. The DRT_ATTACH_FAX value can be combined with the DRT_EMAIL value in one value by using an OR operation.
DeliveryReportAddress: A null-terminated character string. Contains the email address for the delivery report when the DeliveryReportType member is set to 0x00000001 (DRT_E_MAIL). Otherwise, this pointer value can be NULL.
DocumentName: 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.
CallHandle: An unsigned 32-bit integer value containing an optional TAPI call handle. For more information about TAPI, see [MSDN-TAPI2.2]. For more information about this member, see FaxObs_SendDocument.
Reserved: A table of three 32-bit unsigned integer fields (on 32-bit implementations), or 64-bit unsigned integer fields (on 64-bit implementations). If the first value, Reserved[0], is zero, then all values in this table SHOULD be ignored.
If the fax job is a normal job sent to one fax device (port), the Reserved values SHOULD be as follows:
Reserved[0] SHOULD be set to zero or to 0xFFFFFFFF (on 32-bit) or 0x00000000FFFFFFFF (on 64-bit).
Reserved[1] SHOULD contain a device identifier such as the value contained by the DeviceId member of a valid FAX_PORT_INFO (section 2.2.7) or _FAX_PORT_INFO (section 2.2.8) structure, describing one fax port (device).
Reserved[2] SHOULD be ignored.
If the fax job is part of a broadcast sequence executed by the client to send the same fax to multiple recipients, the Reserved values SHOULD be as follows:
Reserved[0] SHOULD be set to 0xFFFFFFFE (on 32-bit) or 0x00000000FFFFFFFE (on 64-bit).
Reserved[1] SHOULD be set to one of the following two values:
A value of 1 (0x00000001 on 32-bit or 0x0000000000000001 on 64-bit) for the first FaxObs_SendDocument method call made by the client to start the broadcast sequence.
A value of 2 (0x00000002 on 32-bit or 0x0000000000000002 on 64-bit) for the second and following FaxObs_SendDocument method calls made by the client to continue and complete a started broadcast sequence.
Reserved[2] SHOULD be set to one of the following two values:
If Reserved[1] is set to a value of 1, Reserved[2] SHOULD be set to zero.
If Reserved[1] is set to a value of 2, Reserved[2] SHOULD contain the job identifier returned by the FaxObs_SendDocument call that started the broadcast sequence.
For more information about this member, see the FaxObs_SendDocument method.