Manual for SB.ProgramsTool 1.0.2

Content
1. Modes of operations of utility. 2. Interaction with the host program. 3. Files on server. 4. Examples of calling the utility for different programming languages. ---------------------------------------- Online version of the manual >>> Contact the author of the program

1. Modes of operations of utility.
Modes of operations of utility: Check for updates. In this mode, the utility checks for the text file availability on the specified address. If it exists, the utility downloads it, reads from it informed about the new version of the program and notifies the user. Settings of check for updates. In this mode, you can configure checks for updates. Ability to write a review about the program. In this mode, the user of your program can write a review about your program which will be sent to your specified e-mail (other software is not required). Ability to send error description and a text file with the report to your specified e-mail. In this mode, the user of your program can write a description of the bug in your program which will be sent to your specified e-mail (other software is not required), also to the letter can be attached a text file (no larger than 100 KB) with the information about error. Ability to notify users of the program a message of any event. In this mode, the utility checks the text file availability on the specified address (or update the old one), if it exists, then the utility downloads it and displays to the user. The file will open as HTML. Links in the file will open in default browser. You can use only those modes that you need, it is easy to configure.

2. Interaction with the host program.
> General rules: Work the utility with the host program is implemented through the launch of the utility with the command line. All parameters passed to the command line should be in quotes ("option"). Parameters must be separated by a space. In the folder "Settings" should be file "UMessages.ini", it sets the frequency to check for update messages, by default, once in 7 days. You can change the frequency within 1-30 days. Recommended the file "ProgramsTool.ini" with the settings for your program put in the installation package (in folder "Settings"). Utility is compatible with Windows 2000 and later, when running on earlier versions of Windows in the folder "Settings" file will be created "NotSupportedOS.ini". If the host program runs in full screen mode, then windows of utility will not be visible, take it into account, especially when you run the utility in modes the "Write a review about the program" and "Send error description". Explanation of parameters:
> ProName - program name * ProVers - program version * Lang - language (only "Russian" or "English") * EMail - e-mail to send the feedback and bug reports * PatchToExe - path (absolute) to the exe-file of host program * PatchToFile - path (absolute) to the attachment file with the bug report, the text files only, no more than 100 kb. URLtoFile - folder with the file with information about update * Example: "http://sbgames.narod.ru/newversion/" Update file name = ProName +'_'+ ProVers + '. Txt' for Russian and ProName +'_'+ ProVers + 'Eng.txt' for English. If you don't use Russian language then the file ProName +'_'+ ProVers + '. Txt' may be empty (but it must be). If the file is missing on the server, the utility believes that software updates were not. URLtoMSG - folder with the file with information about update file of messages. Example: "http://sbgames.narod.ru/messages/" filename with the date of update of the Russian version message = 'Messages_LastEdit.txt' filename with a Russian message = 'Messages.txt' and / or filename with the date of update of the English version message = 'MessagesEng_LastEdit.txt' filename with a English message = 'MessagesEng.txt' * - required parameters. If you are not using any modes of utility, you must still fill out the required fields, without files on the server utility will work fine.
Startup modes: Mode - check for updates of program or update message. If the new version or message is available then show window for a user. Running the utility with this command line is recommended to do when your program starts and closes. Utility in this mode does not show its window, if there is no update or message. Command Line in this mode: '0 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+URLtoFile+' '+URLtoMSG Settings of check for updates. Recommended that you make in your program button "Configure check for updates" and call the utility with this command line when pressing a button. This is the default mode, if you have run the utility without any command line. Command Line in this mode: '1 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+URLtoFile Write a review about the program. Recommended that you make in your program button "Write a comment on program" and call the utility with this command line when pressing a button. Command Line in this mode: '2 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+EMail Send error description and a text file with the report to your e-mail. If you have an error handler, then you can do in his window button "Reveal to the author" and call the utility with this command line when pressing a button. In this mode update and message windows are not shown. Command Line in this mode: '3 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+EMail+' '+PatchToFile Erase settings files of utility. Utility can store their settings in the folder "Application Data" (if an entry in the folder "Settings" is not possible) to remove the settings from the folder "Appication Data" call the utility in this mode. Command Line in this mode: 'UnInstall '+ProName

3. Files on server.
- How to fill out the files on the server: File with a message about a new version of the program. The file name must be equal ProName +'_'+ ProVers + '. Txt' for the Russian language and ProName +'_'+ ProVers + 'Eng.txt' for English.
  1.1.0.2k.ru.update 16.08.2010 http://sbgames.narod.ru/program.html 43709 The program has changed)) | Number of new version Released new version Link to a page with a new version The size of the new version in bytes Description of changes in the new version (reads to the end of file)
- An example of the completed file>>> File with the date of last change the message. File name 'Messages_LastEdit.txt' for the Russian language and 'MessagesEng_LastEdit.txt' for English.
  2010.01.21 | Date of change (year, month, day)
An example of the completed file>>> Message file. File name 'Messages.txt' for the Russian language and 'MessagesEng.txt' for English. File in HTML. The utility will download only this file, but if they are inserted links to images from the server, they will be shown in message (but it is not recommended))

4. Examples of calling the utility for different programming languages.
- Delphi
  uses ShellApi; ... ShellExecute(0, nil, pChar(ExtractFiledir(paramStr(0))+'\SB.ProgramsTool.exe'), pchar(CmStr), nil, 5);

Manual for SB.ProgramsTool 1.0.2