Platform SDK: Fax Services

FAX_CONFIGURATION

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.

typedef struct _FAX_CONFIGURATION {
  DWORD     SizeOfStruct;      // structure size, in bytes
  DWORD     Retries;           // maximum retransmission attempts
  DWORD     RetryDelay;        // minutes between retransmission
                               // attempts
  DWORD     DirtyDays;         // days to keep unsent fax in queue
  BOOL      UseDeviceTsid;     // TSID flag
  BOOL      ServerCp;          // cover page flag
  BOOL      PauseServerQueue;  // paused queue flag
  FAX_TIME  StartCheapTime;    // start of discount period
  FAX_TIME  StopCheapTime;     // end of discount period
    BOOL      ArchiveOutgoingFaxes; 
                                 // archive outgoing fax flag
  LPCTSTR   ArchiveDirectory;  // pointer to archive directory
  LPCTSTR   InboundProfile;    // pointer to e-mail profile to use
                                 // when routing an incoming fax 
} FAX_CONFIGURATION, *PFAX_CONFIGURATION;

Members

SizeOfStruct: 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.
Retries: 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.
RetryDelay: Specifies a DWORD variable that indicates the number of minutes that will elapse between retransmission attempts by the fax server.
DirtyDays: 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 are specified, or if the sending device receives a busy signal multiple times.
Branding: 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.
UseDeviceTsid: 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.
ServerCp: 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.
PauseServerQueue: 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.
StartCheapTime: 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.
StopCheapTime: 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.
ArchiveOutgoingFaxes: 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.
ArchiveDirectory: 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.
InboundProfile: Pointer to a constant null-terminated character string that specifies a MAPI user profile. This is the profile the fax server uses for routing incoming fax transmissions and for sending delivery reports (DRs) and nondelivery reports (NDRs).
If you specify the DrEmailAddress member of the FAX_PRINT_INFO structure, the InboundProfile member is required. If you set the DeliveryReportType member of the FAX_JOB_ENTRY structure to DRT_EMAIL, this member is also required. For more information see Enabling MAPI Functionality in a Fax Client Application.

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.

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.
  Unicode: Declared as Unicode and ANSI structures.

FAX_CONFIGURATION

Members

Remarks

Requirements

See Also