Back to product page
- Introduction
- Overview
- License agreement
- Configuration file creation
- Getting Started
- Objects
- Enumerations
- wodAppUpdate
- Methods
- Properties
- AutoRestart
- Blocking
- CmdAfter
- CmdBefore
- CmdLine
- DebugFile
- DialogNoteText
- DialogNoteURL
- DialogText
- Files
- ForceRestart
- GlobalTerminate
- Login
- Messages
- Notification
- Password
- PrevExist
- ProxyHostname
- ProxyLogin
- ProxyPassword
- ProxyPort
- ProxyType
- ReplaceRule
- RequireAdmin
- ServiceIsRunning
- Signature
- State
- StateText
- Timeout
- UpdaterName
- UpdaterTimeout
- URL
- URLHandler
- UserIsAdmin
- Version
- Visible
- WinVersion
- Events
- Notifications
- UpdFile
- UpdFiles
- UpdMessage
- UpdMessages
- UpdProcess
- UpdProcesses
- How to get support?
- Technical information
- Fast notifications interface
- Error list
Configuration file creation
General
wodAppUpdate expects to retrieve configuration file from your server as textual file. You should take few minutes to create that file. It's really easy - just follow these steps, but you can also copy/paste sections from below directly to your new file to get started quickly! Use UpdSqueze to quickly get [File] section created from files!
1. Make sure your configuration file starts with the signature! If it doesn't, wodAppUpdate will ignore the file completely
2. Add [File] section for each file you want to be able to be updated
Typically, it will look like this:
#Update file signature
[Global]
CmdLine=%APP% --service
[File]
Name=yourapp.exe
URL=http://your.server.com/downloads/yourapp.exe
Version=1.2.2.8
[File]
Name=addin.dll
Date=20061001183600
URL=http://your.server.com/downloads/addin.dll
Version=2.4.4.57
Size=12899
There can be as many [File] or [Message] sections as you wish, but only one [Global] section. Just make sure there are no empty lines inside the section!
[Global] section can have these lines:
Name | Decription |
---|---|
AutoRestart | Determines if application is auto-started (default value) after update is made. |
CmdAfter | Determines if some command is executed after all files are replaced. For example, you can start some service here. |
CmdBefore | Determines if some command is executed before any of files are replaced. For example, you can stop some service here. |
CmdLine | Holds full command line, with any arguments, of file to start after files are replaced. Besides typical %VARIABLES% as described below for Path entry, you can also specify %APP% value which holds full path to EXE filename that is currently running. |
RequireAdmin | Overrides RequireAdmin property - if you want to force admin privileges remotely. You can also force nonadmin privileges, property value is overridden if this line exists. |
Name | Decription |
---|---|
CmdAfter | Determines if some command is executed after file is replaced. For example, register the COM service manually. |
CmdBefore | Determines if some command is executed before file is replaced. For example, you can unregister the COM service manually. |
Compressed | Determines if file kept online is compressed or not. It will be decompressed on the fly during download. Should be used with UpdSqueze. |
Date (or CreationDate) |
This is creation date of the file, in a format YYYYMMDDhhmmss. You should set it if you plan to use ReplaceRule property set to ReplaceIfDate value |
DateFormat | When set to "utc" then wodAppUpdate expects that all dates for this file is expressed in UTC timezone. Any other setting is ignored. |
Name | Defines name of the file, as will be seen in UpdFile.Name property |
MD5 | Holds base64 encoded MD5 hash of the file in uncompressed form. |
ModificationDate | This is modification date of the file, in a format YYYYMMDDhhmmss. You should set it if you plan to use ReplaceRule property set to ReplaceIfModificationDate value |
Path |
Defines full destination path where file is
installed. You can use also environment constants
such as %USERPROFILE%, %APPDIR%, %WINDOWS%, %SYSTEM%, etc.., but also shell folders such as %FILE% (for the file being updated), %APPDATA%,%DESKTOP%, etc... (just make sure you put them inside % %). This cannot be relative path - you must use
absolute full path, with the help of above
constants if neccessary! |
Register | Determines if file should be registered as COM server or not. If set to True, wodAppUpdate will call DllRegisterServer exported function from the file. | ReplaceRule | Determines file specific fule for replacement, and overrides ReplaceRule global setting for this file. |
Size | Defines size of the file. If not specified, wodAppUpdate will try to retrieve information from the server. If it fails, it will still work but wodAppUpdate will not be able to show correct progress information during the download. |
UncompressedSize | Holds original uncompressed file size. wodAppUpdate does not use this information. However, you can provide it and your application can obtain it through File.UncompressedSize property. |
URL | This is full path of the file so that wodAppUpdate can download it. If name ends with '.gz' then wodAppUpdate assumes it is compressed using UpdSqueze file and will decompress it after download |
Version | Holds version info. If wodAppUpdate has same file with lower version, if will perform the replacement. |