SetFaxParam Method

 

Description   This method sets the different parameters of a fax object

Usage            [FAX].SetFaxParam FaxID ParamType Data

Returns        Zero on success or a negative error code on an error.

 

Remarks       FaxID                 Long           The ID of a fax object created by CreateFaxObject.

ParamType        Short          The type of fax parameter to be set. Can be one of the following constants:

FP_COMPRESSION               - the compression type of the fax object.

FP_ECM                                - is ECM enabled when sending this fax object.

FP_BINARY                            - is BFT enabled when sending this fax object.

FP_WIDTH                             - the width of the pages in the fax.

FP_LENGTH                          - the length of the pages in the fax.

FP_RESOLUTION                  - the resolution of the pages.

FP_PAGENUM                       - the number of pages in fax.

FP_SEND                               - returns True if the fax object is supposed to be sent, False otherwise.

FP_COLOR                            - the color setting of the fax object.

FP_COLORTYPE                    - the type of color fax object.

Data                   Short          The new value for the fax parameter  specified by ParamType. The constant values for the different fax parameters are listed at the method CreateFaxObject.

See Also        CreateFaxObject method, GetFaxParam method