FaxEnumJobs

The FaxEnumJobs function enumerates all queued and active fax jobs on the fax server to which the client has connected. The function returns detailed information for each fax job to the fax client application.

BOOL WINAPI FaxEnumJobs(
  HANDLE FaxHandle,          // handle to the fax server
  PFAX_JOB_ENTRY *JobEntry,  // buffer to receive array of job data
  LPDWORD JobsReturned       // number of fax job structures returned
);

Parameters

FaxHandle

[in] Specifies a fax server handle returned by a call to the FaxConnectFaxServer function.

JobEntry

[out] Pointer to the address of a buffer to receive an array of FAX_JOB_ENTRY structures. Each structure describes one fax job. The data includes, among other items, the job type and status; recipient and sender identification; scheduling and delivery settings; and the page count. For information about memory allocation, see the following Remarks section.

JobsReturned

[out] Pointer to a DWORD variable to receive the number of FAX_JOB_ENTRY structures the function returns in the JobEntry parameter.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.

Remarks

The FaxEnumJobs function returns a list of fax jobs on the fax server of interest, as well as information available about each job. A fax administration application typically calls this function to display the fax job queue for administrative or query purposes. For more information, see Managing Fax Jobs.

The FaxEnumJobs function allocates the memory required for the FAX_JOB_ENTRY buffer array pointed to by the JobEntry parameter. An application must call the FaxFreeBuffer function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable with BackOffice Small Business Server.
  Header: Declared in Winfax.h.
  Library: Included as a resource in Winfax.dll.
  Unicode: Implemented as Unicode and ANSI versions on all platforms.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Functions, FaxConnectFaxServer, FaxFreeBuffer, FaxGetJob, FAX_JOB_ENTRY