Skip to content

Latest commit

 

History

History
181 lines (107 loc) · 7.95 KB

ns-winfax-fax_configurationa.md

File metadata and controls

181 lines (107 loc) · 7.95 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:winfax._FAX_CONFIGURATIONA
FAX_CONFIGURATIONA (winfax.h)
The FAX_CONFIGURATION structure contains information about the global configuration settings of a fax server. (ANSI)
*PFAX_CONFIGURATIONA
FAX_CONFIGURATION
FAX_CONFIGURATION structure [Fax Service]
FAX_CONFIGURATIONA
FAX_CONFIGURATIONW
PFAX_CONFIGURATION
PFAX_CONFIGURATION structure pointer [Fax Service]
_mfax_fax_configuration_str
fax._mfax_fax_configuration_str
winfax/FAX_CONFIGURATION
winfax/FAX_CONFIGURATIONA
winfax/FAX_CONFIGURATIONW
winfax/PFAX_CONFIGURATION
fax\_mfax_fax_configuration_str.htm
Fax
VS|fax|~\fax\faxlegacy_14aa.htm
12/05/2018
*PFAX_CONFIGURATIONA, FAX_CONFIGURATION, FAX_CONFIGURATION structure [Fax Service], FAX_CONFIGURATIONA, FAX_CONFIGURATIONW, PFAX_CONFIGURATION, PFAX_CONFIGURATION structure pointer [Fax Service], _mfax_fax_configuration_str, fax._mfax_fax_configuration_str, winfax/FAX_CONFIGURATION, winfax/FAX_CONFIGURATIONA, winfax/FAX_CONFIGURATIONW, winfax/PFAX_CONFIGURATION
winfax.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
FAX_CONFIGURATIONW (Unicode) and FAX_CONFIGURATIONA (ANSI)
Windows
FAX_CONFIGURATIONA, *PFAX_CONFIGURATIONA
19H1
_FAX_CONFIGURATIONA
winfax/_FAX_CONFIGURATIONA
PFAX_CONFIGURATIONA
winfax/PFAX_CONFIGURATIONA
FAX_CONFIGURATIONA
winfax/FAX_CONFIGURATIONA
c++
APIRef
kbSyntax
HeaderDef
Winfax.h
FAX_CONFIGURATION
FAX_CONFIGURATIONA
FAX_CONFIGURATIONW

FAX_CONFIGURATIONA structure

-description

The FAX_CONFIGURATION structure contains information about the global configuration settings of a fax server. The structure includes data on retransmission, branding, archive, and cover page settings; discount rate periods; and the status of the fax server queue.

-struct-fields

-field SizeOfStruct

Type: DWORD

Specifies the size, in bytes, of the FAX_CONFIGURATION structure. The calling application must set this member to sizeof(FAX_CONFIGURATION) before it calls the FaxSetConfiguration function.

-field Retries

Type: DWORD

Specifies a DWORD variable that indicates the number of times the fax server will attempt to retransmit an outgoing fax if the initial transmission fails.

-field RetryDelay

Type: DWORD

Specifies a DWORD variable that indicates the number of minutes that will elapse between retransmission attempts by the fax server.

-field DirtyDays

Type: DWORD

Specifies a DWORD variable that indicates the number of days the fax server will retain an unsent job in the fax job queue. A transmission might not be sent, for example, if an invalid fax number or date is specified, or if the sending device receives a busy signal multiple times.

-field Branding

Type: BOOL

Specifies a Boolean variable that indicates whether the fax server should generate a brand (banner) at the top of outgoing fax transmissions. If this member is TRUE, the fax server generates a brand that contains transmission-related information like the transmitting station identifier, date, time, and page count.

-field UseDeviceTsid

Type: BOOL

Specifies a Boolean variable that indicates whether the fax server will use the device's transmitting station identifier instead of the value specified in the Tsid member of the FAX_JOB_PARAM structure. If this member is TRUE, the server uses the device's transmitting station identifier.

-field ServerCp

Type: BOOL

Specifies a Boolean variable that indicates whether fax client applications can include a user-designed cover page with the fax transmission. If this member is TRUE, the client must use a common cover page stored on the fax server. If this member is FALSE, the client can use a personal cover page file.

-field PauseServerQueue

Type: BOOL

Specifies a Boolean variable that indicates whether the fax server has paused the fax job queue. If this member is TRUE, the queue has been paused.

-field StartCheapTime

Type: FAX_TIME

Specifies a FAX_TIME structure that indicates the hour and minute at which the discount period begins. The discount period applies only to outgoing transmissions.

-field StopCheapTime

Type: FAX_TIME

Specifies a FAX_TIME structure that indicates the hour and minute at which the discount period ends. The discount period applies only to outgoing transmissions.

-field ArchiveOutgoingFaxes

Type: BOOL

Specifies a Boolean variable that indicates whether the fax server should archive outgoing fax transmissions. If this member is TRUE, the server archives outgoing transmissions in the directory specified by the ArchiveDirectory member.

-field ArchiveDirectory

Type: LPCTSTR

Pointer to a constant null-terminated character string that contains the fully qualified path of the directory in which outgoing fax transmissions will be archived. The path can be a UNC path or a path beginning with a drive letter. The fax server ignores this member if the ArchiveOutgoingFaxes member is FALSE. This member can be NULL if the ArchiveOutgoingFaxes member is FALSE.

-field Reserved

- InboundProfile

Type: LPCSTR

The inbound routing profile used for email.

-remarks

The fax client application passes the FAX_CONFIGURATION structure in a call to the FaxSetConfiguration function to change the global configuration settings for the fax server of interest. If the application calls the FaxGetConfiguration function, it returns the current settings in a FAX_CONFIGURATION structure. For more information, see Fax Server Configuration Management.

Note

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

-see-also

FAX_JOB_PARAM

FAX_TIME

Fax Service Client API Structures

Fax Service Client API for Windows 2000

FaxGetConfiguration

FaxSetConfiguration