Registry Mnemonics - Revision history

Barb: /* Using the Windows Registry in your IB Programs */

2011-11-08T19:19:25Z

Using the Windows Registry in your IB Programs

← Older revision		Revision as of 19:19, 8 November 2011
Line 66:		Line 66:

	The fourth parameter to (RegSetValue=) specifies the type of data being stored:		The fourth parameter to (RegSetValue=) specifies the type of data being stored:
-	0: ~~numeric~~	+	0: DWORD
	1: string (this is used in the above example)		1: string (this is used in the above example)

Line 74:		Line 74:
	input Result$		input Result$

-	(RegGetValue) returns some additional information along with "+OK" which identifies the data type of the value. "+OK 1:" indicates a string. If instead of 1 it was 0 this indicates a ~~number~~.	+	(RegGetValue) returns some additional information along with "+OK" which identifies the data type of the value. "+OK 1:" indicates a string. If instead of 1 it was 0 this indicates a DWORD.
	if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK		if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK

Barb: /* Using the Windows Registry in your IB Programs */

2011-11-08T19:16:19Z

Using the Windows Registry in your IB Programs

← Older revision		Revision as of 19:16, 8 November 2011
Line 68:		Line 68:
	0: numeric		0: numeric
	1: string (this is used in the above example)		1: string (this is used in the above example)
-	~~2: multi-string~~

	Here's the code to retrieve the setting:		Here's the code to retrieve the setting:
Line 75:		Line 74:
	input Result$		input Result$

-	(RegGetValue) returns some additional information along with "+OK" which identifies the data type of the value. "+OK 1:" indicates a string. If instead of 1 it was 0 this indicates a number~~; 2 indicates a multi-string~~.	+	(RegGetValue) returns some additional information along with "+OK" which identifies the data type of the value. "+OK 1:" indicates a string. If instead of 1 it was 0 this indicates a number.
	if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK		if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK

Barb: /* Using the Windows Registry in your IB Programs */

2011-11-08T18:57:20Z

Using the Windows Registry in your IB Programs

← Older revision		Revision as of 18:57, 8 November 2011
Line 8:		Line 8:
	'''Syntax:'''		'''Syntax:'''

-	<b>Print (RegCreateKey = Type$, BaseKey$, SubKey$)	+	<b>Print (RegCreateKey = Type$, BaseKey$, SubKey$, 0)
	</b>		</b>
	Creates a new registry entry.		Creates a new registry entry.
Line 57:		Line 57:
	Here's how to test the result of the call:		Here's how to test the result of the call:
	if strip(Result$) ne "+OK" GoTo RegError		if strip(Result$) ne "+OK" GoTo RegError
		+
		+	(NOTE: The fourth parameter to the (RegCreateKey=) is RFU. For now it must always be 0).

	Here's the code to set the value of the User's directory choice:		Here's the code to set the value of the User's directory choice:

Barb at 23:48, 7 November 2011

2011-11-07T23:48:05Z

← Older revision		Revision as of 23:48, 7 November 2011
Line 52:		Line 52:
	print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)		print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)
	input Result$		input Result$
-	print (RegCreateKey="USER",STARTUPBASEKEY$,~~UserName~~$,0)	+	print (RegCreateKey="USER",STARTUPBASEKEY$,User$,0)
	input Result$		input Result$

Line 62:		Line 62:
	print (RegSetValue = "USER", RegKey$, USERDIR$,UserDir$,1)		print (RegSetValue = "USER", RegKey$, USERDIR$,UserDir$,1)
	input Result$		input Result$
		+
		+	The fourth parameter to (RegSetValue=) specifies the type of data being stored:
		+	0: numeric
		+	1: string (this is used in the above example)
		+	2: multi-string

	Here's the code to retrieve the setting:		Here's the code to retrieve the setting:
-	RegKey$ = STARTUPBASEKEY$ + "\" + ~~UserName~~$	+	RegKey$ = STARTUPBASEKEY$ + "\" + User$
	print (RegGetValue = "USER", RegKey$, USERDIR$)		print (RegGetValue = "USER", RegKey$, USERDIR$)
	input Result$		input Result$
Line 70:		Line 75:
	(RegGetValue) returns some additional information along with "+OK" which identifies the data type of the value. "+OK 1:" indicates a string. If instead of 1 it was 0 this indicates a number; 2 indicates a multi-string.		(RegGetValue) returns some additional information along with "+OK" which identifies the data type of the value. "+OK 1:" indicates a string. If instead of 1 it was 0 this indicates a number; 2 indicates a multi-string.
	if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK		if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK
		+
		+	Here's how to delete just the entry that stores the directory choice for the user:
		+	RegKey$ = STARTUPBASEKEY$ + "\" + User$
		+	print (RegDeleteValue = "USER", RegKey$, USERDIR$)
		+	input Result$

	Here's how to delete the user's entry and all of its associated name/value pairs:		Here's how to delete the user's entry and all of its associated name/value pairs:
-	print (RegDeleteKey = "USER", STARTUPBASEKEY$ ,~~UserName~~$)	+	print (RegDeleteKey = "USER", STARTUPBASEKEY$ ,User$)
	input Result$		input Result$


	The Registry Mnemonics were introduced in Comet16/32 2011.		The Registry Mnemonics were introduced in Comet16/32 2011.

Barb at 18:33, 7 November 2011

2011-11-07T18:33:14Z

← Older revision		Revision as of 18:33, 7 November 2011
Line 32:		Line 32:

	For all functions:		For all functions:
-	Type$ = "USER" or "SYSTEM" where "USER" translates as HKCU\Software; "SYSTEM" translates as HKLM\Software	+	Type$ = "USER" or "SYSTEM" where "USER" translates as HKCU\Software; "SYSTEM" translates as HKLM\Software.
-	BaseKey$ = an EXISTING registry key which may contain "\" for subkeys, For example: "~~Signature Systems~~\~~DocMgr~~"	+	BaseKey$ = an EXISTING registry key which may contain "\" for subkeys, For example: "MyCompanyName\MyAppName".
		+	After each PRINT an INPUT must be done to determine the success of failure of the call. The string returned will be either "+OK" or "-ERR" followed by more information.


	'''Example:'''		'''Example:'''
-		+	Here's an example of how to store a Comet directory name choice for a particular user:
	Length 254 & Local RegKey$		Length 254 & Local RegKey$
		+	Length 30 & Local User$
		+	Length 3 & Local UserDir$
	SET STARTUPBASEKEY$ = "MyCompanyName\MyAppName\Settings"		SET STARTUPBASEKEY$ = "MyCompanyName\MyAppName\Settings"
-	SET ~~REPORTSDIR~~$ = "~~RptDir~~"	+	SET USERDIR$ = "UserDir"

		+	Note that each key level of the entry must be created individually, thus it requires 4 PRINTS to create the final key HKCU\Software\MyCompanyName\MyAppName\Settings\Username:
	print (RegCreateKey="USER","","MyCompanyName",0)		print (RegCreateKey="USER","","MyCompanyName",0)
	input Result$		input Result$
-
	print (RegCreateKey="USER","MyCompanyName","MyAppName",0)		print (RegCreateKey="USER","MyCompanyName","MyAppName",0)
	input Result$		input Result$
-
	print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)		print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)
	input Result$		input Result$
-
	print (RegCreateKey="USER",STARTUPBASEKEY$,UserName$,0)		print (RegCreateKey="USER",STARTUPBASEKEY$,UserName$,0)
	input Result$		input Result$

-	if strip(Result$) ne "+OK" ~~UseReg = false~~	+	Here's how to test the result of the call:
		+	if strip(Result$) ne "+OK" GoTo RegError

		+	Here's the code to set the value of the User's directory choice:
	RegKey$ = STARTUPBASEKEY$ + "\" + User$		RegKey$ = STARTUPBASEKEY$ + "\" + User$
-	print (RegSetValue = "USER", RegKey$, ~~REPORTSDIR~~$,~~RptDir~~$,1)	+	print (RegSetValue = "USER", RegKey$, USERDIR$,UserDir$,1)
	input Result$		input Result$

		+	Here's the code to retrieve the setting:
	RegKey$ = STARTUPBASEKEY$ + "\" + UserName$		RegKey$ = STARTUPBASEKEY$ + "\" + UserName$
-	print (RegGetValue = "USER", RegKey$, ~~REPORTSDIR~~$)	+	print (RegGetValue = "USER", RegKey$, USERDIR$)
	input Result$		input Result$

		+	(RegGetValue) returns some additional information along with "+OK" which identifies the data type of the value. "+OK 1:" indicates a string. If instead of 1 it was 0 this indicates a number; 2 indicates a multi-string.
	if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK		if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK
		+
		+	Here's how to delete the user's entry and all of its associated name/value pairs:
		+	print (RegDeleteKey = "USER", STARTUPBASEKEY$ ,UserName$)
		+	input Result$


	The Registry Mnemonics were introduced in Comet16/32 2011.		The Registry Mnemonics were introduced in Comet16/32 2011.

Barb at 18:11, 7 November 2011

2011-11-07T18:11:42Z

← Older revision		Revision as of 18:11, 7 November 2011
Line 1:		Line 1:
-	~~'''~~Using the Windows Registry in your IB Programs~~'''~~	+	==Using the Windows Registry in your IB Programs==

-	'''~~<b>~~Introduction:~~</b>~~'''	+	'''Introduction:'''

	The Registry Mnemonics allow you to create and manage Windows registry settings for your IB application. Entries may be made under either HKEY_CURRENT_USER\Software or HKEY_LOCAL_MACHINE\Software.		The Registry Mnemonics allow you to create and manage Windows registry settings for your IB application. Entries may be made under either HKEY_CURRENT_USER\Software or HKEY_LOCAL_MACHINE\Software.
		+

	'''Syntax:'''		'''Syntax:'''
Line 26:		Line 27:
	</b>		</b>
	Deletes the specified Name/Value pair.		Deletes the specified Name/Value pair.
		+

	'''Discussion:'''		'''Discussion:'''
Line 36:		Line 38:
	'''Example:'''		'''Example:'''

-	Length 254 & Local RegKey$	+	Length 254 & Local RegKey$
-		+	SET STARTUPBASEKEY$ = "MyCompanyName\MyAppName\Settings"
-	SET STARTUPBASEKEY$ = "MyCompanyName\MyAppName\Settings"	+	SET REPORTSDIR$ = "RptDir"
-		+
-	SET REPORTSDIR$ = "RptDir"	+
-		+
-	~~print (RegCreateKey="USER","","MyCompanyName",0)~~	+
-		+
-	~~input Result$~~	+
-		+
-	~~print (RegCreateKey="USER","MyCompanyName","MyAppName",0)~~	+
-		+
-	~~input Result$~~	+
-		+
-	~~print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)~~	+
-		+
-	~~input Result$~~	+
-		+
-	~~print (RegCreateKey="USER",STARTUPBASEKEY$,UserName$,0)~~	+
-		+
-	~~input Result$~~	+

-	~~if strip~~(~~Result$) ne~~ "~~+OK~~" ~~UseReg = false~~	+	print (RegCreateKey="USER","","MyCompanyName",0)
		+	input Result$

-	~~RegKey$~~ = ~~STARTUPBASEKEY$ +~~ "\" ~~+ User~~$	+	print (RegCreateKey="USER","MyCompanyName","MyAppName",0)
		+	input Result$

-	print (~~RegSetValue~~ = "USER", ~~RegKey$~~, ~~REPORTSDIR$~~,~~RptDir$,1~~)	+	print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)
		+	input Result$

-	input Result$	+	print (RegCreateKey="USER",STARTUPBASEKEY$,UserName$,0)
		+	input Result$

-	~~RegKey$ = STARTUPBASEKEY~~$ + "~~\" + UserName$~~	+	if strip(Result$) ne "+OK" UseReg = false

-	print (~~RegGetValue~~ = "USER", RegKey$, REPORTSDIR$)	+	RegKey$ = STARTUPBASEKEY$ + "\" + User$
		+	print (RegSetValue = "USER", RegKey$, REPORTSDIR$,RptDir$,1)
		+	input Result$

-	input Result$	+	RegKey$ = STARTUPBASEKEY$ + "\" + UserName$
		+	print (RegGetValue = "USER", RegKey$, REPORTSDIR$)
		+	input Result$

-	if sub(Result$,1,6) = "+OK 1:"	+	if sub(Result$,1,6) = "+OK 1:" GoTo RegSettingOK


	The Registry Mnemonics were introduced in Comet16/32 2011.		The Registry Mnemonics were introduced in Comet16/32 2011.

Barb at 17:50, 7 November 2011

2011-11-07T17:50:38Z

← Older revision		Revision as of 17:50, 7 November 2011
Line 1:		Line 1:
-	~~<h1>~~	+	'''Using the Windows Registry in your IB Programs'''

-	~~Using the Windows Registry in your IB Programs~~	+	'''<b>Introduction:</b>'''

-	~~</h1>~~
-	~~{\| cellpadding=5 cellspacing=2~~
-	~~\|-valign="top"~~
-	~~\|<b>Introduction:</b>~~
-	\|
	The Registry Mnemonics allow you to create and manage Windows registry settings for your IB application. Entries may be made under either HKEY_CURRENT_USER\Software or HKEY_LOCAL_MACHINE\Software.		The Registry Mnemonics allow you to create and manage Windows registry settings for your IB application. Entries may be made under either HKEY_CURRENT_USER\Software or HKEY_LOCAL_MACHINE\Software.
-	~~\|-valign="top"~~	+
-	\| '''Syntax:'''	+	'''Syntax:'''
-	\|	+
	<b>Print (RegCreateKey = Type$, BaseKey$, SubKey$)		<b>Print (RegCreateKey = Type$, BaseKey$, SubKey$)
	</b>		</b>
Line 32:		Line 27:
	Deletes the specified Name/Value pair.		Deletes the specified Name/Value pair.

-	~~\|-valign="top"~~	+	'''Discussion:'''
-	\| '''Discussion:'''	+
-	\|	+
	For all functions:		For all functions:
	Type$ = "USER" or "SYSTEM" where "USER" translates as HKCU\Software; "SYSTEM" translates as HKLM\Software		Type$ = "USER" or "SYSTEM" where "USER" translates as HKCU\Software; "SYSTEM" translates as HKLM\Software
	BaseKey$ = an EXISTING registry key which may contain "\" for subkeys, For example: "Signature Systems\DocMgr"		BaseKey$ = an EXISTING registry key which may contain "\" for subkeys, For example: "Signature Systems\DocMgr"

-	~~<!--~~	+
-	~~\|-valign="top"~~	+	'''Example:'''
-	\|'''Example:'''	+
	Length 254 & Local RegKey$		Length 254 & Local RegKey$
		+
	SET STARTUPBASEKEY$ = "MyCompanyName\MyAppName\Settings"		SET STARTUPBASEKEY$ = "MyCompanyName\MyAppName\Settings"
		+
	SET REPORTSDIR$ = "RptDir"		SET REPORTSDIR$ = "RptDir"

	print (RegCreateKey="USER","","MyCompanyName",0)		print (RegCreateKey="USER","","MyCompanyName",0)
		+
	input Result$		input Result$
		+
	print (RegCreateKey="USER","MyCompanyName","MyAppName",0)		print (RegCreateKey="USER","MyCompanyName","MyAppName",0)
		+
	input Result$		input Result$
		+
	print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)		print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)
		+
	input Result$		input Result$
		+
	print (RegCreateKey="USER",STARTUPBASEKEY$,UserName$,0)		print (RegCreateKey="USER",STARTUPBASEKEY$,UserName$,0)
-	input Result$	+
		+	input Result$
		+
	if strip(Result$) ne "+OK" UseReg = false		if strip(Result$) ne "+OK" UseReg = false

	RegKey$ = STARTUPBASEKEY$ + "\" + User$		RegKey$ = STARTUPBASEKEY$ + "\" + User$
		+
	print (RegSetValue = "USER", RegKey$, REPORTSDIR$,RptDir$,1)		print (RegSetValue = "USER", RegKey$, REPORTSDIR$,RptDir$,1)
		+
	input Result$		input Result$

	RegKey$ = STARTUPBASEKEY$ + "\" + UserName$		RegKey$ = STARTUPBASEKEY$ + "\" + UserName$
		+
	print (RegGetValue = "USER", RegKey$, REPORTSDIR$)		print (RegGetValue = "USER", RegKey$, REPORTSDIR$)
		+
	input Result$		input Result$
		+
	if sub(Result$,1,6) = "+OK 1:"		if sub(Result$,1,6) = "+OK 1:"

-	\|

-	\|}
-	~~-->~~
	The Registry Mnemonics were introduced in Comet16/32 2011.		The Registry Mnemonics were introduced in Comet16/32 2011.

Barb at 17:41, 7 November 2011

2011-11-07T17:41:54Z

← Older revision		Revision as of 17:41, 7 November 2011
Line 8:		Line 8:
	\|<b>Introduction:</b>		\|<b>Introduction:</b>
	\|		\|
-	The Registry Mnemonics allow you to create and manage Windows registry settings for your IB application. Entries may be made under either ~~HKCU~~\Software or ~~HKLM~~\Software.	+	The Registry Mnemonics allow you to create and manage Windows registry settings for your IB application. Entries may be made under either HKEY_CURRENT_USER\Software or HKEY_LOCAL_MACHINE\Software.
	\|-valign="top"		\|-valign="top"
	\| '''Syntax:'''		\| '''Syntax:'''
Line 42:		Line 42:
	\|-valign="top"		\|-valign="top"
	\|'''Example:'''		\|'''Example:'''
		+	Length 254 & Local RegKey$
		+	SET STARTUPBASEKEY$ = "MyCompanyName\MyAppName\Settings"
		+	SET REPORTSDIR$ = "RptDir"

		+	print (RegCreateKey="USER","","MyCompanyName",0)
		+	input Result$
		+	print (RegCreateKey="USER","MyCompanyName","MyAppName",0)
		+	input Result$
		+	print (RegCreateKey="USER","MyCompanyName\MyAppName","Settings",0)
		+	input Result$
		+	print (RegCreateKey="USER",STARTUPBASEKEY$,UserName$,0)
		+	input Result$
		+	if strip(Result$) ne "+OK" UseReg = false
		+
		+	RegKey$ = STARTUPBASEKEY$ + "\" + User$
		+	print (RegSetValue = "USER", RegKey$, REPORTSDIR$,RptDir$,1)
		+	input Result$
		+
		+	RegKey$ = STARTUPBASEKEY$ + "\" + UserName$
		+	print (RegGetValue = "USER", RegKey$, REPORTSDIR$)
		+	input Result$
		+	if sub(Result$,1,6) = "+OK 1:"

	\|		\|

Barb: Created page with "

Using the Windows Registry in your IB Programs

{| cellpadding=5 cellspacing=2 |-valign="top" |Introduction: | The Registry Mnemonics allow you to create and m..."

2011-11-07T17:04:25Z

Created page with "<h1> Using the Windows Registry in your IB Programs </h1> {| cellpadding=5 cellspacing=2 |-valign="top" |<b>Introduction:</b> | The Registry Mnemonics allow you to create and m..."

New page

<h1>

Using the Windows Registry in your IB Programs

</h1>
{| cellpadding=5 cellspacing=2
|-valign="top"
|<b>Introduction:</b>
|
The Registry Mnemonics allow you to create and manage Windows registry settings for your IB application. Entries may be made under either HKCU\Software or HKLM\Software.
|-valign="top"
| '''Syntax:'''
|
<b>Print (RegCreateKey = Type$, BaseKey$, SubKey$)
</b>
Creates a new registry entry.

<b>Print (RegDeleteKey = Type$, BaseKey$, SubKey$)
</b>
Deletes a registry entry and all of its name/value pairs.

<b>Print (RegSetValue = Type$, BaseKey$, Name$, Value$, Type)
</b>
Assigns the specified Name/Value pair of a given type.

<b>Print (RegGetValue = Type$, BaseKey$, Name$)
</b>
Returns the the Type and Value of the specified Name/Value pair.

<b>Print (RegDeleteValue = Type$, BaseKey$, Name$)
</b>
Deletes the specified Name/Value pair.

|-valign="top"
| '''Discussion:'''
|
For all functions:
Type$ = "USER" or "SYSTEM" where "USER" translates as HKCU\Software; "SYSTEM" translates as HKLM\Software
BaseKey$ = an EXISTING registry key which may contain "\" for subkeys, For example: "Signature Systems\DocMgr"


The Registry Mnemonics were introduced in Comet16/32 2011.