FaxSetConfigurationA function (winfax.h)

Article
02/09/2023

A fax client application calls the FaxSetConfiguration function to change the global configuration settings for the fax server to which the client has connected. The configuration data can include, among other items, retransmission, branding, archive and cover page settings; discount rate periods; and the status of the fax server queue.

Syntax

WINFAXAPI BOOL FaxSetConfigurationA(
  [in] HANDLE                   FaxHandle,
  [in] const FAX_CONFIGURATIONA *FaxConfig
);

Parameters

[in] FaxHandle

Type: HANDLE

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

[in] FaxConfig

Type: const FAX_CONFIGURATION*

Pointer to a FAX_CONFIGURATION structure. The structure contains data to modify the current fax server configuration settings.

Return value

Type: BOOL

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.

Return code	Description
ERROR_ACCESS_DENIED	Access is denied. FAX_CONFIG_SET access is required.
ERROR_ACCESS_DENIED	Access is denied. FAX_PORT_QUERY access is required.
ERROR_INVALID_PARAMETER	The FaxConfig parameter is NULL, or the SizeOfStruct member of the specified FAX_CONFIGURATION structure is not equal to sizeof(FAX_CONFIGURATION).

Remarks

A fax administration application typically calls the FaxSetConfiguration function to administer the global configuration settings for a fax server. To query the settings, an application can call the FaxGetConfiguration function. For more information, see Fax Server Configuration Management.

Note

The winfax.h header defines FaxSetConfiguration 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