Setup Cache - Response

Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.

ElementAttributes
🟥 <outSETUPS>
|- 🟦 <XMLDetail>[]
|- 🟥 <Setups>🔸Count, 🔸Max
|- |- 🟦 <Setup>[]🔸Account, 🔸HitCount, 🔸Index, 🔸LastUsed, 🔸Path, 🔸UseCount

🟥 <outSETUPS> (Module)

Element TypeData Type
Parent-

This is the module element of the XML setup file cache response. This element simply acts as a container for all of the result child elements.

Attributes: None

🟦 <XMLDetail>[]

Element TypeData TypeDefault
DataTextNULL

The <XMLDetail> elements are messages passed back to the calling application which detail the status of the XML request. If the SCEX issues any warnings regarding unrecognized elements or attributes, then each warning message will be displayed in an <XMLDetail> element.

Attributes: None

🟥 <Setups>

Element TypeData Type
Parent-

This element contains the number of setup files currently cached (as an attribute), as well as the capacity of the cache. It is also the parent element for the individual elements containing the information for each cached setup file.

Attributes: 🔸Count, 🔸Max

🔸 Count

Data TypeValues
Integer[1...999]

This attribute specifies the number of setup files currently cached.

🔸 Max

Data TypeValues
Integer[1...999]

This attribute specifies the maximum number of setup files which may be cached. An application can alter this value using the SetMax command (see the Cmd attribute).

🟦 <Setups>[] → <Setup>

Element Type
Empty

This element contains relevant data for every setup file present in the cache. The element itself contains no data. Instead, all of the information of use is contained in the following attributes of the element:

Attributes: 🔸Account, 🔸HitCount, 🔸Index, 🔸LastUsed, 🔸Path, 🔸UseCount

🔸 Account

Data TypeValues
Integer[1...9999]

This account number associated with the setup file in the cache.

🔸 HitCount

Data TypeValues
Integer[0...]

This attribute contains a value indicating the number of times this setup file was requested for check-out. It is zero based, thus the first time a setup file is requested, it's HitCount is set to zero.

🔸 Index

Data TypeValues
Integer[1...9999]

This attribute associates the a number with each setup file in the cache.

🔸 LastUsed

Data TypeValues
Timehh:mm:ss

The LastUsed attribute reports the number of hours, minutes, and seconds (hh:mm:ss) since the setup file was last requested by the SCE.

🔸 Path

Data TypeValues
Textspecial

The Path attribute is the data directory path associated with the setup file. Note that on the Windows platform, file and path names are not case sensitive. Thus, all data directory paths are converted to lowercase upon entry to the SCE. Howwever, on platforms which are case sensitive (e.g. Linux), no changes are made to the case of characters which make up the data directory path.

🔸 UseCount

Data TypeValues
Integer[1...9999]

The UseCount attribute returns the number of times the setup file is currently in use at the time the request is made. When setup files are used in the SCE, a check-out and check-in process is used. That is, the SCE checks out a setup file and increments it's use count to signal to the SCE to not do anything with the setup file until the SCE is done with the setup file, it checks it back in and decreases its use count.

Thus, if a setup file's use count is greater than zero, it means that the setup file could still be in use somewhere within the engine (or it could mean that for some reason, it was not checked back in). In either case, a Flush command will not remove any setup files with a UseCount > 0.

To remove a setup file from the cache with a UseCount > 0, one would need to use the HardFlush command. Please see the Cmd attribute for more information on the various commands you can send to the XML interface.