Platform SDK: Fax Services

FAX_SEND

The FAX_SEND structure contains information about an outbound fax document. The structure contains the name of the file that holds the fax data stream, the name and telephone number of the calling device, and the name and telephone number of the receiving device.

typedef struct _FAX_SEND {
    DWORD   SizeOfStruct;    // structure size, in bytes
    LPWSTR  FileName;        // pointer to outbound data stream file
    LPWSTR  CallerName;      // pointer to caller name
    LPWSTR  CallerNumber;    // pointer to caller number
    LPWSTR  ReceiverName;    // pointer to receiver name
    LPWSTR  ReceiverNumber;  // pointer to receiver number
    BOOL    Branding;        // brand flag
    HCALL   CallHandle;      // handle to an active call
    DWORD   Reserved[3];     // must be zero
} FAX_SEND, *PFAX_SEND;

Members

SizeOfStruct: Specifies, in bytes, the size of the FAX_SEND structure. Before calling the FaxDevSend function, the fax service sets this member to sizeof(FAX_SEND).
FileName: Pointer to a null-terminated Unicode character string that specifies the full path to the file that contains the data stream for an outbound fax document. The data stream is a Tagged Image File Format, Class F for facsimile (TIFF 6.0 Class F) file. For more information, see Fax Image Format.
CallerName: Pointer to a null-terminated Unicode character string that specifies the name of the calling device. The fax service provider will send this name to the remote receiving device when the fax service provider sends the fax. For more information, see the following Remarks section.
CallerNumber: Pointer to a null-terminated Unicode character string that specifies the telephone number of the calling device. (This number is also the transmitting station identifier.) The fax service provider will send this number to the remote receiving device when the fax service provider sends the fax. For more information, see the following Remarks section.
ReceiverName: Pointer to a null-terminated Unicode character string that specifies the name of the device that will receive the outbound fax document.
ReceiverNumber: Pointer to a null-terminated Unicode character string that specifies the telephone number of the device that will receive the outbound fax document. This is the telephone number that the fax service provider will dial.
If you specify the CallHandle member, the ReceiverNumber member must be NULL.
Branding: Specifies whether the fax service provider should generate a brand (banner) at the top of the fax transmission. If this member is TRUE, the fax service provider generates a brand that contains transmission-related information such as the called station identifier, date, time, and page count.
CallHandle: Specifies a call handle returned by the TAPI 2.x LINE_CALLSTATE message. The fax service provider must call the lineSetMediaMode function to correctly set the call's media mode.
If this member is specified, the application should transmit the fax using the existing line connection instead of initiating a new call. If this member is NULL, the fax service provider must dial the number specified by the ReceiverNumber member to transmit the fax.
Reserved[3]: This member is reserved for future use by Microsoft. It must be set to zero.

Remarks

The fax service provider can reformat the CallerName and CallerNumber members. The fax service provider can then transmit the reformatted data to the remote sending device as the called subscriber identifier (CSI) to comply with "T.Routing" requirements. For more information, see the RoutingInfo and CSI members of the FAX_DEV_STATUS structure.

The fax service provider can also use the reformatted data to add a brand to the fax transmission.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxdev.h.

FAX_SEND

Members

Remarks

Requirements

See Also