<div class="content" name="FAX_JOB_ENTRY" uuid="7c6ea406-edbd-4a5b-b8f2-5ad5084c750d"><p>The <b>FAX_JOB_ENTRY</b> structure describes one <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_9369467f-ee6b-427f-9d5c-f9cacc40ae66" data-linktype="relative-path">fax job</a>. The structure
includes information about the job type and status, the recipient&#39;s and the
sender&#39;s <b>personal profiles</b> (section <a href="bd422bcf-7ce8-4576-addb-89345ea84f9f" data-linktype="relative-path">3.1.1</a>), scheduling and
delivery settings, and the page count.</p><p>This structure is used as an input argument for the <b>FaxObs_SetJob</b>
(section <a href="9f9da633-7698-4074-a2d9-c5aa551df19e" data-linktype="relative-path">3.1.4.2.11</a>)
method.</p><dl>
<dd>
<div><pre> typedef struct {
   DWORD SizeOfStruct;
   DWORD JobId;
   LPCWSTR UserName;
   DWORD JobType;
   DWORD QueueStatus;
   DWORD Status;
   DWORD Size;
   DWORD PageCount;
   LPCWSTR RecipientNumber;
   LPCWSTR RecipientName;
   LPCWSTR Tsid;
   LPCWSTR SenderName;
   LPCWSTR SenderCompany;
   LPCWSTR SenderDept;
   LPCWSTR BillingCode;
   DWORD ScheduleAction;
   SYSTEMTIME ScheduleTime;
   DWORD DeliveryReportType;
   LPCWSTR DeliveryReportAddress;
   LPCWSTR DocumentName;
 } FAX_JOB_ENTRY,
  *PFAX_JOB_ENTRY;
</pre></div>
</dd></dl><p><b>SizeOfStruct:</b> A <b>DWORD</b> (<a href="../ms-dtyp/cca27429-5689-4a16-b2b4-9325d93e4ba2" data-linktype="relative-path">[MS-DTYP]</a>
section <a href="../ms-dtyp/262627d8-3418-4627-9218-4ffe110850b2" data-linktype="relative-path">2.2.9</a>)
that indicates the size, in bytes, of the <b>FAX_JOB_ENTRY</b> structure. This
value MUST be 92 or 136 bytes. When filled in on a 32-bit implementation, this
value SHOULD be 92 bytes. When filled in on a 64-bit implementation, this value
SHOULD be 136 bytes.</p><p><b>JobId:</b> A <b>DWORD</b> that indicates a unique
number that identifies the fax jobs of interest. This is the same kind of job
identifier number as the <i>JobId</i> parameter for the <b>FAX_SetJob</b>
(section <a href="7fa3d24d-6028-4d07-8391-1af766d07358" data-linktype="relative-path">3.1.4.1.82</a>)
function.</p><p><b>UserName:</b> A null-terminated character string
that contains the name of the fax user account that submitted the fax job, if
known; otherwise, a NULL pointer.</p><p><b>JobType:</b> A <b>DWORD</b> that indicates the
type of the fax job of interest. This field is one of the following values,
which are defined in section 3.1.1.</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Value/code</p>
   </th>
   <th>
   <p>Meaning</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>0x00000000</td>
  <td>The job type is JT_UNKNOWN.</td>
 </tr><tr>
  <td>0x00000001</td>
  <td>The job type is JT_SEND.</td>
 </tr><tr>
  <td>0x00000002</td>
  <td>The job type is JT_RECEIVE.</td>
 </tr><tr>
  <td>0x00000003</td>
  <td>The job type is JT_ROUTING.</td>
 </tr><tr>
  <td>0x00000004</td>
  <td>The job type is JT_FAIL_RECEIVE.</td>
 </tr></tbody></table>
</dd></dl><p><b>QueueStatus:</b> A <b>DWORD</b> variable
containing a set of bit flags indicating the job status of the fax job
identified by the <b>JobId</b> field. This value MUST be a bitwise OR
combination of one or more of the <b>Job Status</b> values listed in section
3.1.1.</p><p><b>Status:</b> A <b>DWORD</b> that specifies the
status of the fax <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_b61cbe7c-c902-495a-aac5-c4ae2fa11d6b" data-linktype="relative-path">device (or
port)</a> that received or sent the fax job described by this structure,
captured at the time the job information was recorded. This member SHOULD be
ignored when this structure is used as an input argument for the <b>FaxObs_SetJob</b>
method. This value MUST be one of the following predefined device status codes.</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Value/code</p>
   </th>
   <th>
   <p>Meaning</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>FPS_UNKNOWN 0x00000000</td>
  <td>The status of the device is unknown.</td>
 </tr><tr>
  <td>FPS_DIALING 0x20000001</td>
  <td>The device is dialing a fax number.</td>
 </tr><tr>
  <td>FPS_SENDING 0x20000002</td>
  <td>The device is sending a fax document.</td>
 </tr><tr>
  <td>FPS_RECEIVING 0x20000004</td>
  <td>The device is receiving a fax document.</td>
 </tr><tr>
  <td>FPS_COMPLETED 0x20000008</td>
  <td>The device completed sending or receiving a fax transmission.</td>
 </tr><tr>
  <td>FPS_HANDLED 0x20000010</td>
  <td>The fax service processed the outbound fax document; the fax service provider (FSP) will transmit the fax document.</td>
 </tr><tr>
  <td>FPS_UNAVAILABLE 0x20000020</td>
  <td>The device is not available because it is in use by another application.</td>
 </tr><tr>
  <td>FPS_BUSY 0x20000040</td>
  <td>The device encountered a busy signal.</td>
 </tr><tr>
  <td>FPS_NO_ANSWER 0x20000080</td>
  <td>The receiving device did not answer the call.</td>
 </tr><tr>
  <td>FPS_BAD_ADDRESS 0x20000100</td>
  <td>The device dialed an invalid fax number.</td>
 </tr><tr>
  <td>FPS_NO_DIAL_TONE 0x20000200</td>
  <td>The sending device cannot complete the call because it does not detect a dial tone.</td>
 </tr><tr>
  <td>FPS_DISCONNECTED 0x20000400</td>
  <td>The fax call was disconnected by the sender or the caller.</td>
 </tr><tr>
  <td>FPS_FATAL_ERROR 0x20000800</td>
  <td>The device has encountered a fatal protocol error.</td>
 </tr><tr>
  <td>FPS_NOT_FAX_CALL 0x20001000</td>
  <td>The device received a call that was a data call or a voice call.</td>
 </tr><tr>
  <td>FPS_CALL_DELAYED 0x20002000</td>
  <td>The device delayed a fax call because the sending device received a busy signal multiple times. The device cannot retry the call because dialing restrictions exist (some countries and regions restrict the number of retry attempts when a number is busy).</td>
 </tr><tr>
  <td>FPS_CALL_BLACKLISTED 0x20004000</td>
  <td>The device could not complete a call because the telephone number was blocked or reserved; emergency numbers such as 911 are blocked.</td>
 </tr><tr>
  <td>FPS_INITIALIZING 0x20008000</td>
  <td>The device is initializing a call.</td>
 </tr><tr>
  <td>FPS_OFFLINE 0x20010000</td>
  <td>The device is offline and unavailable.</td>
 </tr><tr>
  <td>FPS_RINGING 0x20020000</td>
  <td>The device is ringing.</td>
 </tr><tr>
  <td>FPS_AVAILABLE 0x20100000</td>
  <td>The device is available.</td>
 </tr><tr>
  <td>FPS_ABORTING 0x20200000</td>
  <td>The device is aborting a fax job.</td>
 </tr><tr>
  <td>FPS_ROUTING 0x20400000</td>
  <td>The device is routing a received fax document.</td>
 </tr><tr>
  <td>FPS_ANSWERED 0x20800000</td>
  <td>The device answered a new call.</td>
 </tr></tbody></table>
</dd></dl><p><b>Size:</b> A <b>DWORD</b> variable that indicates
the total size, in bytes, of the fax document to transmit, if known, or zero
otherwise.  The size, if known, includes the size of the cover page, if a cover
page is present, and the size of the <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_222c82b4-c682-4c5d-b500-a6f0a7b96d4f" data-linktype="relative-path">fax body</a>, if a fax body is
present. The size MUST NOT exceed 4 gigabytes.</p><p><b>PageCount:</b> A <b>DWORD</b> that indicates the
total number of pages in the fax transmission, including the cover page, if
any, and the fax body, if any, of the fax submitted with this fax job. If the
fax is sent to multiple recipients, this total number of pages is the number of
fax pages sent to each individual recipient (not the sum of the fax pages sent
to all recipients).</p><p><b>RecipientNumber:</b> A null-terminated character
string that contains the fax number of the recipient of the fax transmission,
if known, or a NULL pointer otherwise. This information comes from the
recipient&#39;s <b>personal profile</b>.</p><p><b>RecipientName:</b> A null-terminated character
string that contains the name of the recipient of the fax, if known, or a NULL
pointer otherwise. This information comes from the recipient&#39;s <b>personal
profile</b>.</p><p><b>Tsid:</b> A null-terminated character string that
contains the <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_3b1ad462-95fc-4739-b942-4a5670d6ae34" data-linktype="relative-path">transmitting
subscriber identifier (TSID)</a>, if known, or a NULL pointer otherwise. This
information comes from the sender&#39;s <b>personal profile</b>.</p><p><b>SenderName:</b> A null-terminated character string
that contains the fax sender name, if known, or a NULL pointer otherwise. This
information comes from the sender&#39;s <b>personal profile</b>.</p><p><b>SenderCompany:</b> A null-terminated character
string that contains the fax sender company, if known, or a NULL pointer
otherwise. This information comes from the sender&#39;s <b>personal profile</b>.</p><p><b>SenderDept:</b> A null-terminated character string
that contains the fax sender department, if known, or a NULL pointer otherwise.
This information comes from the sender&#39;s <b>personal profile</b>.</p><p><b>BillingCode:</b> A null-terminated character
string that contains the fax billing code, if known, or a NULL pointer
otherwise.</p><p><b>ScheduleAction:</b> A <b>DWORD</b> that indicates
when the fax is to be sent. This can be one of the following values:</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Value/code</p>
   </th>
   <th>
   <p>Meaning</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>JSA_NOW 0x00000000</td>
  <td>The fax is to be sent as soon as a fax device is available.</td>
 </tr><tr>
  <td>JSA_SPECIFIC_TIME 0x00000001</td>
  <td>The fax is to be sent at the time specified by the ScheduleTime field of this FAX_JOB_ENTRY structure.</td>
 </tr><tr>
  <td>JSA_DISCOUNT_PERIOD 0x00000002</td>
  <td>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.</td>
 </tr></tbody></table>
</dd></dl><p><b>ScheduleTime:</b> A <b>SYSTEMTIME</b> ([MS-DTYP]
section <a href="../ms-dtyp/2fefe8dd-ab48-4e33-a7d5-7171455a9289" data-linktype="relative-path">2.3.13</a>)
structure indicating the local date and time to send the fax, in <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_f2369991-a884-4843-a8fa-1505b6d5ece7" data-linktype="relative-path">Coordinated Universal Time
(UTC)</a> format. This parameter MUST be ignored unless the <i>ScheduleAction</i>
parameter is set to 1 (JSA_SPECIFIC_TIME).</p><p><b>DeliveryReportType:</b> A <b>DWORD</b> variable
that indicates the fax delivery report type. This value MUST be one of the <b>FAX_ENUM_DELIVERY_REPORT_TYPES</b>
(section <a href="7a03bb5e-3ba7-45ec-b869-31350298e9b9" data-linktype="relative-path">2.2.76</a>)
enumeration values. The DRT_ATTACH_FAX value can be combined with the DRT_EMAIL
value by an OR operation.</p><p><b>DeliveryReportAddress:</b> A null-terminated
character string that contains the email address for the delivery report, if
known, or a NULL pointer otherwise.</p><p><b>DocumentName:</b> A null-terminated character
string that contains the document name, if known, or a NULL pointer otherwise.</p></div>