FaxCompleteJobParams

The FaxCompleteJobParams function creates both a FAX_COVERPAGE_INFO structure and a FAX_JOB_PARAM structure for a fax client application. This utility function supplies multiple members of these structures with values for the size of the structure, the sender's name, and optional billing code information.

BOOL WINAPI FaxCompleteJobParams(
  PFAX_JOB_PARAM *JobParams,          // pointer to 
                                      //   job information structure
  PFAX_COVERPAGE_INFO *CoverpageInfo  // pointer to 
                                      //   cover page structure
);

Parameters

JobParams

[in/out] Pointer to the address of a buffer to contain a FAX_JOB_PARAM structure. On output, this structure contains members with values that are available from the fax server.

CoverpageInfo

[in/out] Pointer to the address of a buffer to contain a FAX_COVERPAGE_INFO structure. On output, this structure contains members with values that are available from the fax server.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

The fax client application should call the FaxCompleteJobParams function before calling the FaxSendDocument function. This enables the fax server to provide any values that are available for the members of the FAX_JOB_PARAM and the FAX_COVERPAGE_INFO structures. The application should not query the user's registry for this information because the location of the information can change. For more information, see Transmitting Faxes.

The application must call the FaxFreeBuffer function once to deallocate the buffer pointed to by the JobParams parameter, and again to deallocate the buffer pointed to by the CoverpageInfo 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, FaxSendDocument, FaxFreeBuffer, FAX_COVERPAGE_INFO, FAX_JOB_PARAM