Click or drag to resize

SettingManagerAddBasicSetting Method

This method creates and returns a new node with a primitive setting.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void AddBasicSetting(
	string FullName,
	Object DefaultValue,
	[OptionalAttribute] STSAPICONSTANTS Flags,
	out SettingNode SettingNode
)

Parameters

FullName
Type: SystemString
DefaultValue
Type: SystemObject
Flags (Optional)
Type: Kofax.OmniPageCSDK.IproPlusSTSAPICONSTANTS
SettingNode
Type: Kofax.OmniPageCSDK.IproPlusSettingNode
Remarks

If the specified node already exists, a trappable error occurs. The FullName is the dot-separated, absolute path of the setting to be created; the DefaultValue parameter provides a default for this setting. Note that the following characters are reserved for internal use and cannot be contained by the setting name: colon (:), semicolon (;), equal-sign (=) and star (*). If the specified path refers to nodes not yet created in the tree, they are automatically created with no associated settings. The type of the created setting depends on the DefaultValue parameter type, which may contain one of the following type values: integer number, floating point number, Boolean value or a Unicode string.

See Also