FaxCompleteJobParamsA function (winfax.h)

Article
02/09/2023

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.

Syntax

WINFAXAPI BOOL FaxCompleteJobParamsA(
  [in, out] PFAX_JOB_PARAMA      *JobParams,
  [in, out] PFAX_COVERPAGE_INFOA *CoverpageInfo
);

Parameters

[in, out] JobParams

Type: PFAX_JOB_PARAM*

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.

[in, out] CoverpageInfo

Type: PFAX_COVERPAGE_INFO*

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 value

Type: BOOL

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.

Note

The winfax.h header defines FaxCompleteJobParams as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	winfax.h
Library	WinFax.lib