Setup Cache - Request

Please see the Legend to understand the conventions used to document each element and attribute. Note that for requests, the XML elements are documented in alphabetical order by parent element.

🟥 <inSETUPS>

This is the module element of the XML setup file cache request. This element is empty, and thus contains neither data nor child elements. The following attributes of the <inSETUPS> element are defined:

Attributes: 🔹Arg1, 🔹Arg2, 🔹Cmd

🔹 Arg1

This optional attribute is used to specify the first argument for the specified Cmd. Please see the Cmd attribute to determine if this argument is necessary, and if so, what values are valid.

🔹 Arg2

This optional attribute is used to specify the second argument for the specified Cmd. Please see the Cmd attribute to determine if this argument is necessary, and if so, what values are valid.

🔹 Cmd

There are four commands (Cmd) which the setup file cache request recognizes. Each of these commands is detailed below, along with the number of arguments (Arg1 and Arg2) supported.

• List - The List command is the default command used if none is provided, and requires no arguments. Any values specified in Arg1 or Arg2 are ignored. This command simply returns the setup file cache status, and does not act on the setup file cache in any manner.

• Flush - The Flush command flushes (clears) a specified setup file (or files) from RAM based upon values provided in the arguments.

  The Flush command flushes a specified setup file (or files) based upon values provided in the arguments. For each setup file in the cache which matches the criteria found in both of the arguments, if the UseCount is equal to zero, then the setup file will be cleared from the cache.

  • Arg1 holds the path value against which all setup files in the cache will be compared. If the value of Arg1 is all, then all setup files will be matched. Please note that this comparison is case sensitive!

  • Arg2 holds the account value against which all setup files will be compared. Similar to Arg1, a value of all indicates that all setup file wills be matched.

  Example 1: Flush all setup files.

  <inSETUPS Cmd="Flush" Arg1="all" Arg2="all" />
  

  Example 2: Flush all setup files in directory c:\scex\.

  <inSETUPS Cmd="Flush" Arg1="c:\scex\" Arg2="all" />
  

  Example 3: Flush all setup files with account number one.

  <inSETUPS Cmd="Flush" Arg1="all" Arg2="1" />
  

• HardFlush - The HardFlush command operates identically to the Flush command, with the sole exception that all setup files in the cache which match both criteria will be flushed, even if UseCount is greater than zero.

• SetMax - This command allows the calling application to set the maximum cache size to the integer value specified in Arg1. Acceptable values range from 1 to 10,000.

  Note that if an application sets a new maximum cache size to a value less than the number of setup files already present in the cache, none will be flushed. To do so, the application much send a separate Flush command.