.UTIL ADD HOOK

This subroutine adds a record to the Hook file.

Usage:

      PASS         <error_msg>                FIELD            SHARE? Y
      PASS     --- HOOK RECORD                FIELD            SHARE? N
      GOSUB    --- .UTIL ADD HOOK
      *        Check for errors
      IF       --- .UTIL ADD HOOK             NE

Description:

This subroutine adds a record to the Hook file. All parameters are required, if any required parameters are missing, the subroutine will CANCEL.

<error_msg> will contain a detailed error message if the Hook record was not able to be added (Required). This must be PASSed Share "Y" to return the value.

--- HOOK RECORD is the record structure containing the Hook information (Required).

The fields are:

HOOK AP
HOOK VER
HOOK PROC TYPE
HOOK PROC NAM

The above fields identify the process to be hooked (Application, Version, Process Type, Process Name). This must be a valid process in the specified application/version.

HOOK DB: If the hook is only applicable to certain databases, enter that database here, otherwise leave it blank for all databases.

HOOK USER ID: If the hook is only applicable to a certain user, enter that user id here, otherwise leave it blank for all users.

HOOK OV AP
HOOK OV VER
HOOK OV PROC TYPE
HOOK OV PROC NAM

The above fields identify the hook process (Application, Version, Process Type, Process Name). This must be a valid process in the specified application/version.

HOOK OV DB: If you want the hook to switch the user to another database, enter that database here. Leave blank if you want the user to remain in their original database.

HOOK ACTIVE: Enter a Y to make this hook active the next time a user logs on. Blank or N means the hook is not active.

This subroutine is different from .UTIL GET HOOK RECORDS / .UTIL PUT HOOK RECORDS in that the the changes are permanent, and they do not take effect immediately. If you want the changes to take effect immediately, use .UTIL GET HOOK RECORDS to get the current hook records from the engine, make the same changes as you did with this subroutine, then update the engine with .UTIL PUT HOOK RECORDS. Or you can do nothing, and the changes will take effect the next time users log on.

Also see .UTIL CHG HOOK and .UTIL DEL HOOK.

Note that although --- HOOK is an indexed file that can contain more than one record, only the current record buffer will be processed.

Comments:

Read what other users have said about this page or add your own comments.

<--/commentPlugin-->

-- JeanNeron - 2012-03-12