dragonleo/NSIS
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

added registry instructions

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1020 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
rainwater 2002-09-18 13:53:06 +00:00
parent b2b2066c0c
commit 117db54c46
1 changed files with 106 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

106
Docs/src/registry.but
View file

@ -1,2 +1,108 @@
\H{registry} Registry, INI, File Instructions
\S{writeregstr} WriteRegStr
WriteRegStr \e{root_key subkey key_name value}
WriteRegExpandStr \e{root_key subkey key_name value}
Write a string to the registry. root_key must be one of:
\b HKCR or HKEY_CLASSES_ROOT
\b HKLM or HKEY_LOCAL_MACHINE
\b HKCU or HKEY_CURRENT_USER
\b HKU or HKEY_USERS
\b HKCC or HKEY_CURRENT_CONFIG
\b HKDD or HKEY_DYN_DATA
\b HKPD or HKEY_PERFORMANCE_DATA
The error flag is set if the string could not be written to the registry. The type of the string will be REG_SZ for WriteRegStr, or REG_EXPAND_STR for WriteRegExpandStr. If the registry key doesn't exist it will be created.
\S{writeregdword} WriteRegDWORD
WriteRegDWORD \e{root_key subkey key_name value}
This command writes a dword (32 bit integer) to the registry (a user variable can be specified). Valid values for root_key are listed under WriteRegStr. The error flag is set if the dword could not be written to the registry. If the registry key doesn't exist it will be created.
\S{writeregbin} WriteRegBin
WriteRegBin \e{root_key subkey key_name valuedata}
This command writes a block of binary data to the registry. Valid values for root_key are listed under WriteRegStr. Valuedata is in hexadecimal (i.e. DEADBEEF01223211151). The error flag is set if the binary data could not be written to the registry. If the registry key doesn't exist it will be created.
\S{writeinistr} WriteINIStr
WriteINIStr \e{ini_filename section_name entry_name value}
Writes entry_name=value into [section_name] of ini_filename. The error flag is set if the string could not be written to the ini file.
\S{readregstr} ReadRegStr
ReadRegStr \e{user_var(output) root_key sub_key name}
Reads from the registry into the user variable $x. Valid values for root_key are listed under WriteRegStr. The error flag will be set and $x will be set to an empty string ("") if the string is not present. If the value is present, but is of type REG_DWORD, it will be read and converted to a string and the error flag will be set.
\S{readregdword} ReadRegDWORD
ReadRegDWORD \e{user_var(output) root_key sub_key name}
Reads a 32 bit DWORD from the registry into the user variable $x. Valid values for root_key are listed under WriteRegStr. The error flag will be set and $x will be set to an empty string ("" which is 0) if the DWORD is not present. If the value is present, but is not a DWORD, it will be read as a string and the error flag will be set.
\S{readinistr} ReadINIStr
ReadINIStr \e{user_var(output) ini_filename section_name entry_name}
Reads from entry_name in [section_name] of ini_filename and stores the value into user variable $x. The error flag will be set and $x will be assigned to an empty string if the entry is not found.
\S{readenvstr} ReadEnvStr
ReadEnvStr \e{user_var(output) name}
Reads from the environment string "name" and sets the value into the user variable $x. If there is an error reading the string, the user variable is set to empty, and the error flag is set.
\S{expandenvstrings} ExpandEnvStrings
ExpandEnvStrings \e{user_var(output) string}
Expands environment variables in "string" into the user variable $x. If error, the variable is set to empty, and the error flag is set.
\S{deleteregvalue} DeleteRegValue
DeleteRegValue \e{root_key subkey key_name}
Deletes a registry value. Valid values for root_key are listed under WriteRegStr. The error flag is set if the value could not be removed from the registry (or if it didn't exist to begin with).
\S{deleteregkey} DeleteRegKey
DeleteRegKey \e{[/ifempty] root_key subkey}
Deletes a registry key. If /ifempty is specified, the registry key will only be deleted if it has no subkeys (otherwise, the whole registry tree will be removed). Valid values for root_key are listed under WriteRegStr. The error flag is set if the key could not be removed from the registry (or if it didn't exist to begin with).
\S{enumregkey} EnumRegKey
EnumRegKey \e{user_var(output) root_key subkey index}
Set user variable $x with the name of the 'index'th registry key in root_key\\subkey. Valid values for root_key are listed under WriteRegStr. Returns an empty string if there are no more keys, and returns an empty string and sets the error flag if there is an error.
\S{enumregvalue} EnumRegValue
EnumRegValue \e{user_var(output) root_key subkey index}
Set user variable $x with the name of the 'index'th registry value in root_key\\subkey. Valid values for root_key are listed under WriteRegStr. Returns an empty string if there are no more values, and returns an empty string and sets the error flag if there is an error.
\S{deleteinisec} DeleteINISec
DeleteINISec \e{ini_filename section_name}
Deletes the entire section [section_name] from ini_filename. If the section could not be removed from the ini file, the error flag is set.
\S{deleteinistr} DeleteINIStr
DeleteINIStr \e{ini_filename section_name str_name}
Deletes the string str_name from section [section_name] from ini_filename. If the string could not be removed from the ini file, the error flag is set.