Share via

2.2.12 FAX_COVERPAGE_INFO_EXW

  • Article

The FAX_COVERPAGE_INFO_EXW structure is used as an argument for the FAX_SendDocumentEx (section 3.1.4.1.73) call that specifies information about the fax cover page used when sending a fax.

 typedef struct {
   DWORD dwSizeOfStruct;
   DWORD dwCoverPageFormat;
   [string] LPWSTR lpwstrCoverPageFileName;
   BOOL bServerBased;
   [string] LPWSTR lpwstrNote;
   [string] LPWSTR lpwstrSubject;
 } FAX_COVERPAGE_INFO_EXW,
  *PFAX_COVERPAGE_INFO_EXW,
  *LPCFAX_COVERPAGE_INFO_EXW;

dwSizeOfStruct: A DWORD ([MS-DTYP] section 2.2.9) value that holds the total size of the structure, in bytes. This value MUST be 24 or 40 bytes. When filled in on a 32-bit implementation, this value SHOULD be 24 bytes. When filled in on a 64-bit implementation, this value SHOULD be 40 bytes.

dwCoverPageFormat: A DWORD that indicates the format of the cover page template. This MUST be one of the values defined in FAX_ENUM_COVERPAGE_FORMATS (section 2.2.78) enumeration. The required file format for the cover page template is described in FAX_SendDocumentEx (section 3.1.4.1.73) method.

lpwstrCoverPageFileName: A pointer to a null-terminated character string that holds the file name of the cover page template. This file name SHOULD NOT include any path separators. If bServerBased is FALSE, the file extension MUST be ".cov", and except for the terminating null character, the character string MUST contain only characters representing valid hexadecimal digits: "0123456789abcdefABCDEF". If bServerBased is TRUE the file extension SHOULD be ".cov". The cover page file MUST be present in the fax server queue directory when the FAX_SendDocumentEx call is made. If no cover-page information is available, this pointer MUST be NULL.

bServerBased: A Boolean that indicates whether the cover page template specified by the lpwstrCoverPageFileName parameter is a new personal cover page template (when set to FALSE)  or a server-based cover page template (when set to TRUE). For more details on the semantics of TRUE and FALSE, see FAX_SendDocumentEx.

lpwstrNote: A pointer to a null-terminated character string that holds the content for the note field of the cover page.

lpwstrSubject: A pointer to a null-terminated character string that holds the content for the subject field.