GetFaxParam Method

 

Description   This method returns different parameters about an existing fax object.

Usage            [FAX].GetFaxParam FaxID ParamType

Returns        If an error occurs, -1 is returned and FaxError is set.

 

Remarks       FaxID                 Long           The ID of the fax object.

                     

                      ParamType        Short          Specifies the type of information to be returned. It can be one of the following values:

                      FP_TYPE                                - the type of the fax object.

FP_COMPRESSION               - the compression type of the fax object.

FP_ECM                                - is ECM enabled for this fax object.

FP_BINARY                            - is BFT enabled for 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 the fax.

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

FP_COLOR                            -the color setting of the fax object.

FP_COLORTYPE                    - the type of color fax object.

                     

                      The possible return values of the different parameter types are the same constants as those listed in the description of CreateFaxObject method.

See Also        CreateFaxObject method