SettingManagerGetSettingValue Method

public Object GetSettingValue(
	string FullName,
	[OptionalAttribute] int Index
)

Public Function GetSettingValue ( 
	FullName As String,
	<OptionalAttribute> Index As Integer
) As Object

public:
Object^ GetSettingValue(
	[InAttribute] String^ FullName, 
	[OptionalAttribute] [InAttribute] int Index
)

Parameters

FullName

Type: SystemString

Index (Optional)

Type: SystemInt32

Return Value

The FullName parameter is the absolute, dot-separated path of the addressed node that has a setting value. If the addressed node exists but does not have a setting value, the property returns an empty variant, otherwise it returns the value of the particular setting. If the return setting is a primitive type (not array), the Index optional parameter is ignored. If the returned setting is an array, but the Index parameter is -1 or unspecified, the whole array is returned. If the returned setting is an array, and the Index parameter refers to a valid, zero-based index, the requested array element is returned. Passing an invalid value to the Index parameter results in a trappable error.

When modifying settings using this property, consider the following rules; if the addressed setting does not have an associated value or is read-only, a trappable error occurs. If the node is of a primitive type, the Index optional parameter is ignored. If the setting is an array and the Index parameter is -1 or unspecified, the whole array is replaced. If the setting is an array and a valid Index parameter is specified, the requested element is replaced. If the set value type differs from the addressed setting type (this is not recommended), an automatic conversation is attempted. If the conversion fails, a trappable error occurs.

Using the SettingValue method is useful when the type and structure of the stored data is known. If you are unsure of this information, query the particular setting using the Item property and access it through the returned SettingNode object which offers a way to query the requested information.

Reference