FAX_COVERPAGE_INFO

The FAX_COVERPAGE_INFO structure contains data to display on the cover page of a fax transmission. The SizeOfStruct and CoverPageName members are required; other members are optional.

typedef struct _FAX_COVERPAGE_INFO {
  DWORD       SizeOfStruct;       //structure size, in bytes
  //
  // General information
  //
  LPCTSTR     CoverPageName;      //cover page document name
  BOOL        UseServerCoverPage; //local/server file flag
  //
  // Recipient information
  //
  LPCTSTR     RecName;            //pointer to recipient's name
  LPCTSTR     RecFaxNumber;       //pointer to fax number
  LPCTSTR     RecCompany;         //pointer to company name
  LPCTSTR     RecStreetAddress;   //pointer to street address
  LPCTSTR     RecCity;            //pointer to city
  LPCTSTR     RecState;           //pointer to state
  LPCTSTR     RecZip;             //pointer to zip code
  LPCTSTR     RecCountry;         //pointer to country
  LPCTSTR     RecTitle;           //pointer to title
  LPCTSTR     RecDepartment;      //pointer to department
  LPCTSTR     RecOfficeLocation;  //pointer to office location
  LPCTSTR     RecHomePhone;       //pointer to home number
  LPCTSTR     RecOfficePhone;     //pointer to office number
  //
  // Sender information
  //
  LPCTSTR     SdrName;            //pointer to sender's name
  LPCTSTR     SdrFaxNumber;       //pointer to fax number
  LPCTSTR     SdrCompany;         //pointer to company name
  LPCTSTR     SdrAddress;         //pointer to address
  LPCTSTR     SdrTitle;           //pointer to title
  LPCTSTR     SdrDepartment;      //pointer to department
  LPCTSTR     SdrOfficeLocation;  //pointer to office location
  LPCTSTR     SdrHomePhone;       //pointer to home number
  LPCTSTR     SdrOfficePhone;     //pointer to office number
  //
  // Miscellaneous information
  //
  LPCTSTR     Note;               //pointer to note text
  LPCTSTR     Subject;            //pointer to subject line text
  SYSTEMTIME  TimeSent;           //time fax was sent
  DWORD       PageCount;          //total pages in transmission
} FAX_COVERPAGE_INFO, *PFAX_COVERPAGE_INFO; 

Members

SizeOfStruct

Specifies the size, in bytes, of the FAX_COVERPAGE_INFO structure. The calling application must set this member to sizeof(FAX_COVERPAGE_INFO).

CoverPageName

Pointer to a constant null-terminated character string that is the name of the cover page file to associate with the received fax document. The string can be the file name of the common cover page file, or it can be the UNC path to a local cover page file.

UseServerCoverPage

Specifies a Boolean variable that indicates whether the fax cover page file is stored on the local computer or in the common cover page location. A value of TRUE indicates that the cover page file resides in the common cover page location on the fax server.

RecName

Pointer to a constant null-terminated character string that specifies the name of the recipient of the fax transmission.

RecFaxNumber

Pointer to a constant null-terminated character string that specifies the fax number of the recipient of the fax transmission.

RecCompany

Pointer to a constant null-terminated character string that specifies the company name of the recipient of the fax transmission.

RecStreetAddress

Pointer to a constant null-terminated character string that specifies the street address of the recipient of the fax transmission.

RecCity

Pointer to a constant null-terminated character string that is the city of the recipient of the fax transmission.

RecState

Pointer to a constant null-terminated character string that is the state of the recipient of the fax transmission.

RecZip

Pointer to a constant null-terminated character string that is the postal ZIP code of the recipient of the fax transmission.

RecCountry

Pointer to a constant null-terminated character string that is the country of the recipient of the fax transmission.

RecTitle

Pointer to a constant null-terminated character string that is the title of the recipient of the fax transmission.

RecDepartment

Pointer to a constant null-terminated character string that is the department of the recipient of the fax transmission.

RecOfficeLocation

Pointer to a constant null-terminated character string that is the office location of the recipient of the fax transmission.

RecHomePhone

Pointer to a constant null-terminated character string that is the home telephone number of the recipient of the fax transmission.

RecOfficePhone

Pointer to a constant null-terminated character string that is the office telephone number of the recipient of the fax transmission.

SdrName

Pointer to a constant null-terminated character string that is the name of the sender who initiated the fax transmission.

SdrFaxNumber

Pointer to a constant null-terminated character string that is the fax number of the sender who initiated the fax transmission.

SdrCompany

Pointer to a constant null-terminated character string that is the company name of the sender who initiated the fax transmission.

SdrAddress

Pointer to a constant null-terminated character string that is the address of the sender who initiated the fax transmission.

SdrTitle

Pointer to a constant null-terminated character string that is the title of the sender who initiated the fax transmission.

SdrDepartment

Pointer to a constant null-terminated character string that is the department name of the sender who initiated the fax transmission.

SdrOfficeLocation

Pointer to a constant null-terminated character string that is the office location of the sender who initiated the fax transmission.

SdrHomePhone

Pointer to a constant null-terminated character string that is the home telephone number of the sender who initiated the fax transmission.

SdrOfficePhone

Pointer to a constant null-terminated character string that is the office telephone number of the sender who initiated the fax transmission.

Note

Pointer to a constant null-terminated character string that contains the text of a message or note from the sender that pertains to the fax transmission. The text will appear on the cover page.

Subject

Pointer to a constant null-terminated character string that is the subject line of the fax transmission.

TimeSent

Specifies a SYSTEMTIME structure. The fax server sets this member when it initiates the fax transmission. The time is expressed in Coordinated Universal Time (UTC).

PageCount

Specifies a DWORD variable that indicates the total number of pages in the fax transmission.

Remarks

A fax client application passes the FAX_COVERPAGE_INFO structure in a call to the FaxPrintCoverPage function. This enables a user to print a personal cover page at the beginning of a fax transmission. For more information, see Cover Pages and Transmitting Faxes.

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.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Structures, FaxPrintCoverPage, SYSTEMTIME, FaxSendDocument, FaxCompleteJobParams