SettingManagerAddEnumSetting Method

public void AddEnumSetting(
	string FullName,
	int DefaultValue,
	Object EnumValues,
	Object EnumNames,
	[OptionalAttribute] STSAPICONSTANTS Flags,
	out SettingNode SettingNode
)

Public Sub AddEnumSetting ( 
	FullName As String,
	DefaultValue As Integer,
	EnumValues As Object,
	EnumNames As Object,
	<OptionalAttribute> Flags As STSAPICONSTANTS,
	<OutAttribute> ByRef SettingNode As SettingNode
)

public:
void AddEnumSetting(
	[InAttribute] String^ FullName, 
	[InAttribute] int DefaultValue, 
	[InAttribute] Object^ EnumValues, 
	[InAttribute] Object^ EnumNames, 
	[OptionalAttribute] [InAttribute] STSAPICONSTANTS Flags, 
	[OutAttribute] SettingNode^% SettingNode
)

Parameters

FullName

Type: SystemString

DefaultValue

Type: SystemInt32

EnumValues

Type: SystemObject

EnumNames

Type: SystemObject

Flags (Optional)

Type: Kofax.OmniPageCSDK.IproPlusSTSAPICONSTANTS

SettingNode

Type: Kofax.OmniPageCSDK.IproPlusSettingNode

The enumerated setting maintains a list of available (long) values together with their friendly names. The value of the setting can be one of the values specified by the EnumValues parameters as detailed below.

The FullName is the dot-separated, absolute path of the setting to be created. If the specified node already exists, a trappable error occurs. Note that the following characters are reserved for internal use and can not be used in 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 DefaulValue parameter provides a default for this setting. It must be one of the values specified by the EnumValues parameter, otherwise a trappable error occurs. The EnumValues parameter must be a one-dimensional Long array (for Visual Basic programmers) or a SAFEARRAY of longs (in C++ environments) defining the available enum items, otherwise a trappable error occurs. The EnumNames parameter must be the same size, and must be a one-dimensional String array (for Visual Basic programmers) or a SAFEARRAY of BSTRs (in C++ environments) defining the friendly names of the available enum items, otherwise a trappable error occurs.

Reference