FaxGetConfiguration

The FaxGetConfiguration function returns to a fax client application the global configuration settings for the fax server to which the client has connected. The data includes, among other items, retransmission, branding, archive and cover page settings; discount rate periods; and the status of the fax server queue.

BOOL WINAPI FaxGetConfiguration(
  HANDLE FaxHandle,              // handle to the fax server
  PFAX_CONFIGURATION *FaxConfig  // structure to receive configuration data
);

Parameters

FaxHandle

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

FaxConfig

[out] Pointer to the address of a buffer to receive a FAX_CONFIGURATION structure. The structure contains the current configuration settings for the fax server of interest. For information about memory allocation, see the following Remarks section.

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 FaxGetConfiguration function to display the global configuration settings for a fax server. To change the configuration settings, call the FaxSetConfiguration function.

The FaxGetConfiguration function allocates the memory required for the FAX_CONFIGURATION buffer pointed to by the FaxConfig parameter. An application must call the FaxFreeBuffer function to deallocate the resources associated with this parameter.

For more information, see Fax Server Configuration Management and 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, FaxFreeBuffer, FaxConnectFaxServer, FaxSetConfiguration, FAX_CONFIGURATION