FaxGetLicense method

This method is used to reserve a fax runtime license. ActiveAG is based on Natural MicroSystems’ NaturalFax. NaturalFax requires a run-time license for each line it is used on. It is possible to have fewer NaturalFax licenses than there are AG ports in your system and to share these licenses between ports on an as-needed basis. When NaturalFax functions are used (the FaxReceive method and FaxSend method in ActiveAG), NaturalFax will – by default -- attempt to find an available fax license for you. If no license is available (if they’re all in use by other lines, for example) the fax function will fail.

On the other hand, If a fax license has been successfully reserved, then NaturalFax functions will not fail for lack of a license. A license is guaranteed to be available on the requesting line.

The FaxGetLicense method allows you to reserve a fax license for future use, so that your program can use other fax methods without being concerned about the availability of a fax license.

In summary, ActiveAG does not require you to use this method before using other fax methods – but it’s use may be necessary in some cases.

Note: This method should be used carefully. The fax license will be assigned to the particular line until a) that line is closed (see CloseLine method) or b) until the FaxReleaseLicense method is called for that line. This means that the license will be unavailable to any other lines that may need it.

Finally, it may not be safe to assume that your system has enough fax licenses for all it’s ports. If this is true on your system, your program will not be able to reserve a fax license for all lines.

Arguments: None

Returns: A long integer status code (see ActiveAG Status codes)

Property interactions: None.

NOTE: In order for this FAX method to work, the version of ActiveAG that supports FAX must be installed. Other versions of ActiveAG will throw an exception with the code AagErrMethodNotAvail.

To install the version of ActiveAG that supports FAX requires that NMS’ NaturalFax software be installed previously. See the Installation Notes topic.