Parameter 1: The filename of the file to install such as “weather.txt”.
Parameter 2: The destination directory for the file. This is always relative to the root HomeSeer directory. To install a plug-in file to the HomeSeer directory, use “.”. To install a file into the scripts directory, use “.\Scripts” The special destination path of [WINSYS] can also be used to copy the file to the user’s SYSTEM directory.
Parameter 3: This value is a numeric bit field that describes options that should be applied to the install. The value entered here is the decimal representation of the bits. The bits available are:
bit 0 = &h1 = 1 |
The file is an OCX or DLL file and needs to be registered using regsvr32. |
bit 1 = &h2 = 2 |
The file is an EXE file and needs to be registered by calling the EXE file with the switch /regserver. |
bit 2 = &h4 = 4 |
The file is an exe/ocx/dll file and should be unregistered. EXE files are unregistered with /unregserver (if it exists). DLL and OCX files are unregistered with "regsvr32.exe /u". |
bit 3 = &h8 = 8 |
File is a script file and the function hs_install should be called after the package is installed. Make sure this file is the last one in the list if it depends on other files being installed first. |
bit 4 = &h10 = 16 |
Do not install the file if the file already exists. |
bit 5 = &h20 = 32 |
Delete the file if it exists. |
Set this parameter to 0 if the file does not require any of the above options.
Bits may be "ORED" together to represent multiple options. For example, to register an exe file, but do not copy the file if the target already exists, enter: 18 (bit 1 and bit 4 = 12hex or 18 dec)
Note:
Please be familiar with the File
Locations - Directory Standards document before creating your
package an indeed before publishing your script, ASPX, or plug-in package.
weather.txt,.\scripts,0
MainScript.vbs,.\scripts,8
NewInstall.vbs,.\scripts,24
hspi_Plugin.exe,.,6
hspi_Plugin.ocx,.,1