Config:/Hook/*/
| ||||
---|---|---|---|---|
Setting | Explanation | Default / Example | Data Type | Access R,W,A,D |
Interface | The type of API interface to call. | Rexx | Integer | R,W |
Module | The name of the operating system library module that contains the hook function. If the module is contained on the operating system's path, you do not need to specify a directory, and typically also do not need to specify a file extension, unless it is non-standard. | MyDLL | Text | R,W |
Function | The name of the function within the module. For operating systems that don't allow symbolic function names to be exported, this can be an integer ordinal number in text format. For Rexx hooks, this setting is ignored because Rexx currently does not support calling a function within a module. | MyFunction | Text | R,W |
Cache | Whether to cache the API call. In the case of a C interface this means keeping the DLL loaded. In the case of a Rexx interface, it means storing the Rexx function in the macro space cache. | Yes | Integer | R,W |
Parameters |
This is a directory of variables to pass over to the hook function
when it is executed. At execution time, these variables are aliased
into the "parameters:/" variable directory.
All the variables are read only at that point
to prevent multiple simultaneous requests from interfering with
each other. The major reason for specifying parameters to hook functions is to be able to call the same function in the same module for different purposes for different resources. | Text List | R,W |