0LASubrUtilAddHook < Main

---+ .UTIL ADD HOOK

_This subroutine adds a record to the Hook file._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;error_msg&gt;                FIELD            SHARE? Y
      PASS     --- HOOK RECORD                FIELD            SHARE? N
      GOSUB    --- .UTIL ADD HOOK
      *        Check for errors
      IF       --- .UTIL ADD HOOK             NE

</pre>
---++ Description:

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

&lt;error_msg&gt; 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<br /> HOOK VER<br /> HOOK PROC TYPE<br /> HOOK PROC NAME

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<br /> HOOK OV VER<br /> HOOK OV PROC TYPE<br /> HOOK OV PROC NAME

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 set to a specific APPX database, this record will be effective for only that database. If left blank, it will be effective for any 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 [[0LASubrUtilGetHookRecords][.UTIL GET HOOK RECORDS]] / [[0LASubrUtilPutHookRecords][.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 [[0LASubrUtilGetHookRecords][.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 [[0LASubrUtilPutHookRecords][.UTIL PUT HOOK RECORDS]]. Or you can do nothing, and the changes will take effect the next time users log on.

Also see [[0LASubrUtilChgHook][.UTIL CHG HOOK]] and [[0LASubrUtilDelHook][.UTIL DEL HOOK]].

---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2012-03-12
This topic: Main > WebHome > APPX510Features > APPXRuntimeSubroutineAPI > 0LASubrUtilAddHook
Topic revision: r4 - 2018-11-23 - JeanNeron