2.2.28 FAX_CONFIGURATIONW
The FAX_CONFIGURATIONW structure is used as an input parameter for the FAX_SetConfiguration (section 3.1.4.1.76) and FaxObs_SetConfiguration (section 3.1.4.2.25) methods to change the current fax server configuration settings. Along with the FAX_GENERAL_CONFIG (section 2.2.31) structure, this data structure describes the general configuration of the fax server.
-
typedef struct { DWORD SizeOfStruct; DWORD Retries; DWORD RetryDelay; DWORD DirtyDays; BOOL Branding; BOOL UseDeviceTsid; BOOL ServerCp; BOOL PauseServerQueue; FAX_TIME StartCheapTime; FAX_TIME StopCheapTime; BOOL ArchiveOutgoingFaxes; [string] LPCWSTR ArchiveDirectory; [string] LPCWSTR ProfileName; } FAX_CONFIGURATIONW, *PFAX_CONFIGURATIONW;
SizeOfStruct: A DWORD ([MS-DTYP] section 2.2.9) value that holds the total size of the structure, in bytes. This value MUST be either 52 or 64 bytes. When filled in on a 32-bit implementation, this value SHOULD be 52 bytes. When filled in on a 64-bit implementation, this value SHOULD be 64 bytes.
Retries: A DWORD variable that contains the value of the fax transmission retries fax server configuration setting (section 3.1.1).
RetryDelay: A DWORD variable that contains the value of the fax transmission retry delay fax server configuration setting.
DirtyDays: A DWORD variable that contains the value of the dirty days fax server configuration setting.
Branding: A Boolean flag that specifies whether the fax server generates 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 subscriber identifier, date, time, and page count. This flag configures the Branding fax server configuration setting.
UseDeviceTsid: A Boolean flag that specifies whether the fax server uses the device's transmitting subscriber identifier instead of the value specified in the Tsid member of the FAX_JOB_PARAMW (section 2.2.13) structure. If this member is TRUE, the server uses the device's transmitting subscriber identifier. This flag configures the "use of the device's TSID" fax server configuration setting.
ServerCp: A Boolean flag that specifies whether fax client applications can include a user-designed cover page template with the fax transmission. If this member is TRUE, the client MUST use a common cover page template stored on the fax server. If this member is FALSE, the client can use a personal cover page template. This flag configures the personal cover page support fax server configuration setting.
PauseServerQueue: A Boolean flag that specifies whether the fax server has paused the outgoing fax queue. If this member is TRUE, the outgoing fax queue is paused and the Queue State (section 3.1.1) is set to FAX_OUTBOX_PAUSED (0x00000004). If this field is FALSE, the outgoing fax queue is not paused, and the Queue State is either 0x00000000 or FAX_OUTBOX_BLOCKED (0x00000002).
StartCheapTime: Contains a FAX_TIME (section 2.2.61) structure that indicates the hour and minute values of the current start cheap time fax server configuration setting.
StopCheapTime: Contains a FAX_TIME that indicates the hour and minute values of the current stop cheap time fax server configuration setting.
ArchiveOutgoingFaxes: A Boolean flag that specifies whether the fax server archives fax transmissions. If this member is TRUE, the server archives transmissions in the directory specified by the ArchiveDirectory member. This flag configures the Archive Enabled fax server configuration setting.<6>
ArchiveDirectory: A pointer to a constant, null-terminated character string that holds the fully qualified path of the Fax Archive Folder fax server configuration setting. The path can be a UNC path or a path that begins 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.<7>
ProfileName: Reserved (not used) when this structure is used for FAX_SetConfiguration (section 3.1.4.1.76).
-
When used for FaxObs_SetConfiguration (section 3.1.4.2.25), this member is a null-terminated character string containing the profile name fax server configuration setting.