Using the IXLFCOMP Macro

Note

The following information assumes that you are familiar with either the IXLLIST macro or the IXLCACHE macro and that you are using either a list or cache structure. For more information about the IXLLIST macro, see Using List Services (IXLLIST). For more information about the IXLCACHE macro, see Using Cache Services (IXLCACHE).

If you are an IXLLIST or IXLCACHE macro user who specified MODE=ASYNCTOKEN or specified MODE=SYNCTOKEN but had the request processed asynchronously, you can use the IXLFCOMP macro to do either of the following:

Test whether your list or cache request has completed (OPTYPE=TEST). Choose this option if your task cannot be suspended or your program can perform other work while the list or cache request is being processed. IXLFCOMP's return code indicates whether the request has completed.
If the request has already completed, control returns to you so you can check the results of the request in the output areas you specified on the list or cache request.
Have your task suspended until your list or cache request completes (OPTYPE=COMPLETE). Choose this option if your task can be suspended and you have no other work to perform while the list or cache request is being processed.
Once the request completes or if it has already completed when you issued IXLFCOMP, control returns to you so you can check the results of the request in the output areas you specified on the list or cache request.

When you issue the IXLFCOMP macro, you identify the target request using the request token returned from the IXLLIST or IXLCACHE invocation.

Before accessing the answer area information returned from an IXLLIST or IXLCACHE request, be sure to read:

Determining if the Answer Area is Valid, which describes the circumstances under which the answer area information returned by IXLLIST is not valid.
Determining Valid Information in the Answer Area, which describes the circumstances under which the answer area information returned by IXLCACHE is not valid.