Common arguments

The common arguments for the ResultTableRead and ResultTableUpdate are listed here.

  • QueryCode = The entry in FsQuery that has the SQL statement to execute.
  • QueryArgs = A list of replacements values to be used when executing the SQL. This list replaces the numbered tokens in the SQL, i.e., [%1], [%2], etc.
  • QueryNamedArgs = A list of named replacement values to be used when executing the SQL. This list replaces the named tokens in the SQL, i.e., [%%NAMED_TOKEN1], [%%NAMED_TOKEN2]
  • The query is scanned by the system and the list of named tokens is replaced.
    • %%SEARCHTABLE – the name of the current Search Result table
    • %%KEYFIELD– the name of the primary key field for the current search object
    • %USER – the code of the current user
    • %LAB – the code of the current lab
    • %GROUP – the code of the current group
    • %%CURRENT_DB_NAME – the code of the current database connection
    • %%CURRENT_SESSION_ID – the current session ID value
  • Public ReadOnly Property SearchedKeyField As String

    Returns the name of the primary key field for the current search object. (i.e., "ITEM_CODE" when searching for Items, "FORMULA_ID" when searching for Formulas)

  • Public Property SearchSQL() As String

    Enables the script to retrieve and update the SQL that is used to execute the search.

    • Returns Nothing during the PreSearch script hook.
    • Updating the SQL during the PreSearch script hook is ignored.
    • Updating the SQL during the PreSearchExecute script hook is permitted.
    • Updating the SQL during the PostSearch script hook is ignored.