2.2.31 FAX_GENERAL_CONFIG

The FAX_GENERAL_CONFIG data type can be passed as a byte–array parameter to FAX_SetGeneralConfiguration (section 3.1.4.1.80) and FAX_GetGeneralConfiguration (section 3.1.4.1.40) to change or to return the current fax server configuration settings.

This data structure is custom marshaled as follows and uses the custom-marshaling rules defined in section 2.2.1.

Fixed_Portion (88 bytes):

0	1	2	3	4	5	6	7	8	9	1 0	1	2	3	4	5	6	7	8	9	2 0	1	2	3	4	5	6	7	8	9	3 0	1
dwSizeOfStruct
bUseArchive
lpcwstrArchiveLocationOffset
bSizeQuotaWarning
dwSizeQuotaHighWaterMark
dwSizeQuotaLowWaterMark
dwArchiveAgeLimit
Padding
dwlArchiveSize
...
dwQueueAgeLimit
dwRetries
dwRetryDelay
bUseDeviceTSID
Fixed_Portion of dtDiscountStart
Fixed_Portion of dtDiscountEnd
bBranding
bAllowPersonalCP
dwQueueState
bAutoCreateAccountOnConnect
bIncomingFaxesArePublic
Padding

dwSizeOfStruct (4 bytes): A DWORD ([MS-DTYP] section 2.2.9) value containing the size, in bytes, of the structure. MUST be set to 88 bytes.

bUseArchive (4 bytes): A Boolean value that indicates whether the fax server uses an archive to store fax messages after they are successfully sent or received. If this field is TRUE, the fax server MUST archive fax messages. This flag corresponds to the Archive Enabled fax server configuration setting (section 3.1.1).

lpcwstrArchiveLocationOffset (4 bytes): Offset to the lpcwstrArchiveLocation field in the Variable_Data block of the structure.

bSizeQuotaWarning (4 bytes): A Boolean value that indicates whether the fax server MAY issue an implementation-specific warning if the archive quota exceeds the watermarks defined by the dwSizeQuotaHighWatermark and dwSizeQuotaLowWatermark fields. If this field is TRUE, the fax server can issue an implementation-specific warning. This flag configures the size quota warning fax server configuration setting (section 3.1.1).

dwSizeQuotaHighWaterMark (4 bytes): A DWORD value that holds the current value of the fax server configuration setting (section 3.1.1). If the size of the archive exceeds this value, and if the bSizeQuotaWarning field is set to TRUE, an implementation-specific warning can be issued.

dwSizeQuotaLowWaterMark (4 bytes): A DWORD value that holds the current value of the size quota low watermark fax server configuration setting (section 3.1.1). If the size of the archive falls below this value, and if the bSizeQuotaWarning field is set to TRUE, an implementation-specific warning can be issued.

dwArchiveAgeLimit (4 bytes): A DWORD value that holds the current value of the Archive Age Limit fax server configuration setting (section 3.1.1).

Padding (4 bytes): Padding for data alignment to an 8-byte boundary.

dwlArchiveSize (8 bytes): A DWORDLONG ([MS-DTYP] section 2.2.13) value that holds the actual size of the archived data contained in the Fax Archive Folder (section 3.1.1).

dwQueueAgeLimit (4 bytes): A DWORD value that specifies the current queue age limit fax server configuration setting (section 3.1.1). For an outgoing fax job, after this period elapses for a fax job and the fax job is still not transmitted to its destination, the fax server SHOULD delete the respective fax job from the outgoing fax queue. For an incoming fax job, after this period elapses for a fax job, the fax server SHOULD delete the respective fax job from the incoming fax queue. If bUseArchive is TRUE, meaning that the Archive Enabled fax server configuration setting is enabled, the fax server SHOULD archive incoming and outgoing fax messages regardless of whether the time period described by this value (for the queue age limit fax server configuration setting) elapses.

dwRetries (4 bytes): A DWORD value that specifies the current value of the fax transmission retries fax server configuration setting (section 3.1.1).

dwRetryDelay (4 bytes): A DWORD value that specifies the current value of the fax transmission retry delay fax server configuration setting (section 3.1.1).

bUseDeviceTSID (4 bytes): A Boolean value that specifies the current value of the use device's TSID fax server configuration setting (section 3.1.1).

Fixed_Portion of dtDiscountStart (4 bytes): The Fixed_Portion block of a FAX_TIME (section 2.2.61) structure that holds the hour and minute values of the start cheap time fax server configuration setting (section 3.1.1).

Fixed_Portion of dtDiscountEnd (4 bytes): The Fixed_Portion block of a FAX_TIME that holds the hour and minute values of the stop cheap time fax server configuration setting (section 3.1.1).

bBranding (4 bytes): A Boolean value that specifies the current value of the Branding server configuration setting (section 3.1.1). If this field is TRUE, the fax server SHOULD generate an implementation-specific brand that contains transmission-related information, such as the transmitting subscriber identifier, date, time, and page count.

bAllowPersonalCP (4 bytes): A Boolean value that specifies the current value of the personal cover page support fax server configuration setting (section 3.1.1). If this field is TRUE, the client can provide a personal cover page template. If this field is FALSE, the client MUST use a common cover page template stored on the fax server.

dwQueueState (4 bytes): A DWORD value that contains the current value of the Queue State (section 3.1.1). If this value is zero, both the incoming and outgoing queues MUST be unblocked; otherwise, this value MUST be a combination of one or more of the following flags.

Value/code	Meaning
FAX_INCOMING_BLOCKED 0x00000001	Fax service will not receive new incoming faxes.
FAX_OUTBOX_BLOCKED 0x00000002	Fax service will reject submissions of new outgoing faxes to its queue.
FAX_OUTBOX_PAUSED 0x00000004	Fax service will not remove and execute outgoing fax jobs from its queue.

bAutoCreateAccountOnConnect (4 bytes): A Boolean value that contains the current value of the Automatic Account Creation fax server configuration setting (section 3.1.1). A value of TRUE indicates that the setting is enabled; FALSE means that the setting is disabled. For more details, see section 3.1.4.1.10.

bIncomingFaxesArePublic (4 bytes): A Boolean value that contains the current value of the incoming fax viewing permission setting (section 3.1.1). When this setting is TRUE, all incoming faxes SHOULD be accessible for viewing by all users. When it is FALSE, only users whose accounts have FAX_ACCESS_MANAGE_RECEIVE_FOLDER permission MUST be able to view the incoming faxes.

Padding (4 bytes): Padding for data alignment to an 8-byte boundary.

Variable_Data (variable):

0	1	2	3	4	5	6	7	8	9	1 0	1	2	3	4	5	6	7	8	9	2 0	1	2	3	4	5	6	7	8	9	3 0	1
lpcwstrArchiveLocation (variable)
...

lpcwstrArchiveLocation (variable): A null-terminated character string that indicates the archives folder location on the fax server file system. The portion preceding the terminating null character of this string MUST NOT end in a backslash (\) character.