2.2.29 _FAX_CONFIGURATIONW
The _FAX_CONFIGURATIONW data type is the custom-marshaled variant of the FAX_CONFIGURATIONW (section 2.2.28) structure. This data type is used as an output parameter (as a byte array) for FAX_GetConfiguration (section 3.1.4.1.36) and FaxObs_GetConfiguration (section 3.1.4.2.24) to return the current fax server configuration settings. Along with the FAX_GENERAL_CONFIG (section 2.2.31) data structure, this data structure describes the general configuration of the fax server.
This data structure is custom marshaled as follows and uses the custom-marshaling rules defined in section 2.2.1.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Fixed_Portion (52 bytes) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
Variable_Data (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
Fixed_Portion (52 bytes):
-
0
1
2
3
4
5
6
7
8
91
0
1
2
3
4
5
6
7
8
92
0
1
2
3
4
5
6
7
8
93
0
1SizeOfStruct
Retries
RetryDelay
DirtyDays
Branding
UseDeviceTsid
ServerCp
PauseServerQueue
Fixed_Portion_of_StartCheapTime
Fixed_Portion_of_StopCheapTime
ArchiveOutgoingFaxes
ArchiveDirectoryOffset
ProfileNameOffset
-
SizeOfStruct (4 bytes): A DWORD ([MS-DTYP] section 2.2.9) that contains the size, in bytes, of the structure. MUST be set to 52 bytes.
-
Retries (4 bytes): A DWORD variable that contains the value of the fax transmission retries fax server configuration setting (section 3.1.1).
-
RetryDelay (4 bytes): A DWORD variable that contains the value of the fax transmission retry delay fax server configuration setting.
-
DirtyDays (4 bytes): A DWORD variable that contains the value of the dirty days fax server configuration setting.
-
Branding (4 bytes): A Boolean flag that specifies whether the fax server generates a brand (banner) at the top of outgoing fax transmissions. If this field 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 (4 bytes): A Boolean flag that specifies whether the fax server uses the device's transmitting subscriber identifier instead of the value specified in the Tsid field of the FAX_JOB_PARAMW (section 2.2.13) structure. If this field 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 (4 bytes): A Boolean flag that specifies whether fax client applications can include a user-designed cover page template with the fax transmission. If this field is TRUE, the client MUST use a common cover page template stored on the fax server. If this field is FALSE, the client can use a personal cover page template. This flag configures the personal cover page support fax server configuration setting.
-
PauseServerQueue (4 bytes): A Boolean flag that specifies whether the fax server has paused the outgoing fax queue. If this field 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).
-
Fixed_Portion_of_StartCheapTime (4 bytes): The Fixed_Portion block of a _FAX_TIME (section 2.2.62) structure that indicates the hour and minute values of the current start cheap time fax server configuration setting.
-
Fixed_Portion_of_StopCheapTime (4 bytes): The Fixed_Portion block of a _FAX_TIME that indicates the hour and minute values of the stop cheap time fax server configuration setting.
-
ArchiveOutgoingFaxes (4 bytes): A Boolean flag that specifies whether the fax server archives fax transmissions. If this field is TRUE, the server archives fax transmissions. This flag corresponds to the Archive Enabled fax server configuration setting.
-
ArchiveDirectoryOffset (4 bytes): The optional offset to the ArchiveDirectory field in the Variable_Data block. The fax server SHOULD ignore this field and set it to zero if the ArchiveOutgoingFaxes field is FALSE.<8>
-
ProfileNameOffset (4 bytes): Offset to the ProfileName field in the Variable_Data block.
Variable_Data (variable):
-
0
1
2
3
4
5
6
7
8
91
0
1
2
3
4
5
6
7
8
92
0
1
2
3
4
5
6
7
8
93
0
1ArchiveDirectory (variable)
...
ProfileName (variable)
...
-
ArchiveDirectory (variable): A 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.
-
ProfileName (variable): Reserved and MUST be ignored when this structure is used for FAX_GetConfiguration (section 3.1.4.1.36).
-
When used for FaxObs_GetConfiguration (section 3.1.4.2.24), this member is a null-terminated character string containing the profile name fax server configuration setting.