Click or drag to resize

SettingManagerDeleteSetting Method

This method deletes a node or its whole sub-tree from the setting tree.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void DeleteSetting(
	string FullName,
	[OptionalAttribute] bool Recursive
)

Parameters

FullName
Type: SystemString
Recursive (Optional)
Type: SystemBoolean
Remarks

The FullName parameter is the absolute dot-separated path of the node. If the specified node does not exist, a trappable error occurs.

If the node does not have any children, it is simply deleted. If the node has one or more children and the Recursive optional Boolean parameter is True, the whole sub-tree included under the specified node is deleted. If the node has children and the Recursive parameter is False or unspecified, only the setting of the node is deleted and the node itself remains in the tree without a setting. Note that the delivery ("factory") settings (not those created by the application) cannot be deleted.

See Also