FaxSetConfiguration

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.

BOOL WINAPI FaxSetConfiguration(
  HANDLE FaxHandle,                   // handle to the fax server
  CONST FAX_CONFIGURATION *FaxConfig  // new configuration data
);

Parameters

FaxHandle

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

FaxConfig

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

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

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.

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, FaxGetConfiguration, FAX_CONFIGURATION