Share via

2.2.35 FAX_JOB_ENTRY_EXW

  • Article

An array of the FAX_JOB_ENTRY_EXW data type can be passed as an out parameter (as a byte array) in the FAX_EnumJobsEx (section 3.1.4.1.22) calls. The data type can also be passed as an out parameter in the FAX_GetJobEx (section 3.1.4.1.42) calls.

The dwSizeOfStruct and lpcwstrRecipientNumberOffset fields in the Fixed_Portion block MUST NOT be 0. Except for these fields and the dwlMessageId field, all fields of this structure are optional, and if the respective information is not available, the fields in the Fixed_Portion block MUST be zero.

This data structure is custom marshaled as follows and uses the custom-marshaling rules defined in section 2.2.1.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Fixed_Portion (96 bytes)

...

...

...

Variable_Data (variable)

...

Fixed_Portion (96 bytes):


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

dwSizeOfStruct

dwValidityMask

dwlMessageId

...

dwlBroadcastId

...

lpcwstrRecipientNumberOffset

lpcwstrRecipientNameOffset

lpcwstrSenderUserNameOffset

lpcwstrBillingCodeOffset

tmOriginalScheduleTime (16 bytes)

...

...

...

tmSubmissionTime (16 bytes)

...

...

...

Priority

dwDeliveryReportType

lpcwstrDocumentNameOffset

lpcwstrSubjectOffset

pStatus

Padding

dwSizeOfStruct (4 bytes): A DWORD ([MS-DTYP] section 2.2.9) value that specifies the size, in bytes, of the structure. MUST be set to 96 bytes.

dwValidityMask (4 bytes): A DWORD value that holds a bitwise combination of valid fields in the FAX_ENUM_JOB_FIELDS (section 2.2.77) enumeration.

dwlMessageId (8 bytes): A DWORDLONG ([MS-DTYP] section 2.2.13) value that specifies the unique identifier of the job.

dwlBroadcastId (8 bytes): A DWORDLONG value that holds the Broadcast Identifier (section 3.1.1).

lpcwstrRecipientNumberOffset (4 bytes): Offset to the lpcwstrRecipientNumber field in the Variable_Data portion of the structure.

lpcwstrRecipientNameOffset (4 bytes): Offset to the lpcwstrRecipientName field in the Variable_Data portion of the structure.

lpcwstrSenderUserNameOffset (4 bytes): Offset to the lpcwstrSenderUserName field in the Variable_Data portion of the structure.

lpcwstrBillingCodeOffset (4 bytes): Offset to the lpcwstrBillingCode field in the Variable_Data portion of the structure.

tmOriginalScheduleTime (16 bytes): If the fax job described by this structure was created by using the JSA_SPECIFIC_TIME (the dwScheduleAction field in the FAX_JOB_PARAM_EXW (section 2.2.14) structure submitted as the lpJobParams argument to the FAX_SendDocumentEx (section 3.1.4.1.73) call that created the fax job), this field specifies a SYSTEMTIME ([MS-DTYP] section 2.3.13) structure that contains the date and time originally used to send the fax. The time specified is expressed in UTC. Used for outgoing faxes only.

tmSubmissionTime (16 bytes): A SYSTEMTIME that contains the date and time the fax message was submitted for sending. The time specified is expressed in UTC. Used for outgoing faxes only.

Priority (4 bytes): A FAX_ENUM_PRIORITY_TYPE (section 2.2.65) enumeration value that contains the priority of the fax transmission. Used for outgoing faxes only.

dwDeliveryReportType (4 bytes): A DWORD value that specifies the type of receipt that will be delivered to the sender when the fax is successfully sent or when the fax transmission fails. It can also specify whether a receipt will be sent for each recipient or for all of the recipients together. This field normally contains one of the values defined in FAX_ENUM_DELIVERY_REPORT_TYPES (section 2.2.76) enumeration.

lpcwstrDocumentNameOffset (4 bytes): Offset to the lpcwstrDocumentName field in the Variable_Data portion of the structure.

lpcwstrSubjectOffset (4 bytes): Offset to the lpcwstrSubject field in the Variable_Data portion of the structure.

pStatus (4 bytes): Offset to the Fixed_Portion of the pStatus field in the Variable_Data portion of the structure.

Padding (4 bytes): Padding for data alignment to 8-byte boundary.

Variable_Data (variable):


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Fixed_Portion of pStatus (120 bytes)

...

...

...

lpcwstrRecipientNumber (variable)

...

lpcwstrRecipientName (variable)

...

lpcwstrSenderUserName (variable)

...

lpcwstrBillingCode (variable)

...

lpcwstrDocumentName (variable)

...

lpcwstrSubject (variable)

...

Variable_Data of pStatus (variable)

...

Fixed_Portion of pStatus (120 bytes): The Fixed_Portion of the FAX_JOB_STATUS (section 2.2.36) structure containing the job's dynamic status information. When this data structure is used in an array of structures, the Fixed_Portion of pStatus is omitted from here and is placed as a Referenced_Fixed_Portion block as described in section 2.2.1.3.

lpcwstrRecipientNumber (variable): A null-terminated character string that holds the fax number of the fax transmission recipient. This information comes from the recipient's personal profile (section 3.1.1).

lpcwstrRecipientName (variable): A null-terminated character string that holds the name of the fax transmission recipient. This information comes from the recipient's personal profile.

lpcwstrSenderUserName (variable): A null-terminated character string that holds the name of the sender of an outgoing fax job. Used for outgoing faxes only. This information comes from the sender's personal profile.

lpcwstrBillingCode (variable): A null-terminated character string that holds an application-specific or a server-specific billing code that applies to the fax transmission. Billing codes are optional. Used for outgoing faxes only.

lpcwstrDocumentName (variable): A null-terminated character string that holds a document name to associate with the fax document. Used for outgoing faxes only.

lpcwstrSubject (variable): A null-terminated character string that holds the subject used in the fax cover page. Used for outgoing faxes only.

Variable_Data of pStatus (variable): The Variable_Data of the FAX_JOB_STATUS structure containing the job's dynamic status information. When this data structure is used in an array of structures, the Variable_Data of pStatus is omitted from here and is placed in the Variable_Data block for the structure array as described in section 2.2.1.3.