Description   This method creates a new fax object according to the parameters.

Usage            [FAX].CreateFaxObject Type PageNum Resolution Width Length Compression Binary Ecm ColorFax ColorType

Returns        On successful creation of the fax object, the method returns the ID of a new fax object. If an error occurs, the return value is zero.

Remarks       The parameters define the different characteristics of the created fax object:

Type                  Short          The type of fax object

FT_NORMAL                          - for regular monochrome faxes

FT_COLOR                            - for color faxes    

FT_BFT                                  - for Binary File Transfer

PageNum           Short          The number of pages in the fax object

Resolution        Short          Specifies the resolution of the fax

RES_NOCHANGE                  - use default value

RES_98                                 - for low resolution faxes

RES_196                               - for high resolution faxes

Width                Short          The image width of the fax pages

WD_NOCHANGE                   - Use default value (WD_1728)

WD_1728                              - Convert pages to 1728 pixel wide images

WD_2048                              - Convert pages to 2048 pixel wide images

WD_2432                              - Convert pages to 2432 pixel wide images

WD_1216                              - Convert pages to 1216 pixel wide images

WD_864                                - Convert pages to 864 pixel wide images

Length               Short          The image length of the fax pages

LN_NOCHANGE                    - Use default value (LN_UNLIMITED)

LN_A4                                   - Convert pages to A4 length images

LN_B4                                   - Convert pages to B4 length images

LN_UNLIMITED                     - The length of the page is unlimited

Compression     Short          The type of compression used to store the fax

CF_NOCHANGE                    - Use default value (CF_1DMH)

CF_1DMH                             - CCITT Group 3, 1 dimensional compression

CF_2DMR                              - CCITT Group 3, 2 dimensional compression

CF_UNCOMPRESSED           - don’t compress the pages

CF_2DMMR                           - 2 dimensional MMR compression is used

Binary               Short          Enable or disable the use of binary file transfer for the created fax

BF_NOCHANGE                    - Use default value (BF_DISABLE)

BF_DISABLE                         - disables binary file transfer

BF_ENABLE                          - enables binary file transfer

Ecm                                      shortEnable or disable the use of error correction, when sending the fax.

EC_NOCHANGE                    - Use default value (EC_ENABLE)

EC_DISABLE                         - The fax will be sent without using error           correction

EC_ENABLE                          - The fax will be sent using error correction

ColorFax            Short          Enable or disable colorfax capability when sending the fax

COL_NOCHANGE                  - Use default value

COL_DISABLE                      - disable color fax protocol (regular fax)

COL_ENABLE                        - enable color fax protocol (color fax)

ColorType          Short          Defines the type of color fax

                                              CTYPE_TRUECOLOR - the fax will be sent as truecolor image

CTYPE_GRAYSCALE             - the fax will be sent as monochrome image

                      The methods GetFaxParam and SetFaxParam can be used to modify the different parameters of an existing fax object.

See Also        GetFaxParam method, SetFaxParam method