BinPatch Log File Template Documentation

 

1. Language Elements

Not documented here yet, please take a look at template/logfile.txt in your binpatch directory.


2. Object Hierachy

Objects in the BinPatch log file template are organized in a hierachy. There are some predefined objects:

Patch
This object allows you access to the patch file's size, compression ratio and features used or not. It will e.g. tell you if a patch file is specific to a platform or not.
Targets
This object give you a list of all targets that the patch file you create handles.
Company
This object encapsulates all available information about your company. Using these you can easily use or create generic templates that work without modification while still having in your log file, information about that you created the patch file.
Product
Information about the product that the patch file addresses.
Creator
This object encapsultes information about the patch creator. Which version, which product, which patch file format, what platform you used, the machine name, time and date, etc. This is basically all interesting stuff that is not telling you anything the patch file

 

Company

Company Value Description Notes
Company.LongName string Long form of your companies name. Like e.g.. "Kay Hayen Software" in our case. NIY
Company.ShortName string Short ofrm of your company name, e.g. "KHS" in our case. NIY
Company.Address1 string NIY
Company.Address2 string NIY
Company.City string NIY
Company.State string NIY
Company.Country string NIY
Company.WebSite string The URL of the company web site, e.g. http://kayhayen.com NIY
Company.Phone string NIY
Company.Fax string NIY

 

Patch

Patch Type or Value Description Notes
Patch.UTP file item property set NIY
Patch.Archive file item property set NIY
Patch.isCompressed integer 0 = "no", 1 = "yes" NIY
Patch.Archiver string Name of the archiver. Empty if not archived- NIY
Patch.Stub file item property set NIY
Patch.EXE file item property set NIY

 

Target Item

Target item Type or Value Description Notes
*.StartStates list of target state items A list of items that describe the start state states and their contents as found. Implemented
*.Patched list of patchinfo items List of items that describe the patches that were done. Implemented
*.Embedded list of file items List of items that could not be created by patching or you
chose so.
Implemented
*.Obsolete list of file items List of obsolete items that were formerly present and you chose to remove it. Implemented
*.Skipped list of file items List of file items that were found in identical form in all start states and therefore were ignored. NIY
*.isDirectoryTarget integer 0 = files, 1 = directory. Implemented

Target Start State Item

State item Type or Value Description Notes
*.isDirectory list of state items 0 = file, 1 = directory Implemented
*.Contents directory item set List of items that describe the patches that were done. Implemented
*.File File Item set NIY

Directory state item set

Directory item Type or Value Description Notes
*.Path path item set NIY
*.Date integer Should be formated using "Format" tag modifier. NIY
*.Attributes attribute item property set NIY
*.ExtendedEA list of file items NIY
*.Files list of file item NIY
*.ID integer Defines a unique ID for the state

File item set

File item Type or Value Description Notes
*.Path path item set Implemented
*.Size integer Implemented
*.Date integer Should be formated using "Format" tag modifier. Implemented
*.Attributes attribute item property set NIY
*.ExtendedEA list of file items NIY

Path item set

Path item Type or Value Description Notes
*.Relative string Implemented
*.Absolute string Implemented
*.Size integer Implemented

Patchinfo Starte State Item

Path item Type or Value Description Notes
*.ID integer Same as target start state id, use it for lookups Implemented
*.PatchSize integer Size of the patch information to go from this step to the next (or end state) Implemented