get_AltConfidenceString method
The get_AltConfidenceString method gets the confidence level of each character in the referenced field. You can use this method when you need to pass the confidence level of a string to a variable or action.
.NET only: For VBScript, use
theAltConfidenceString property instead.
The confidence level of each character is a digit from 0
(lowest confidence) to 9 (highest confidence). If the confidence level
for a four-character field is 9999, each of the 4 characters has a
confidence level of 9. The XML code adds a value of 1 to the confidence
level so that the range in XML is 1-10. In the following example XML
setup node for the field, Vendor, the confidence
level for the primary character is 6. The confidence level for the
first alternative character is 8, and the confidence level for the
second alternative is 10.
<F id="Vendor">
<V n="TYPE">Vendor</V>
<V n="Position">0,0,0,0</V>
<V n="STATUS">1</V>
<C cn="6,8,10" cr="0,0,0,0">83,49,53</C>
<C cn="6,8,10" cr="0,0,0,0">116,50,54</C>
<C cn="6,8,10" cr="0,0,0,0">105,51,55/C>
<C cn="6,8,10" cr="0,0,0,0">110,52,56</C>
</F>Syntax
- C#
string get_AltConfidenceString(int nIndex)
Applies to
Field objects only.Arguments
- nIndex
- 0 specifies the primary value. Where the field contains multiple recognition, voting, or multiple-pass data entry values, 1 specifies the first alternative, 2 specifies the second alternative, and so on. (See the C# example.)
Returns
String containing the confidence level of each character. The returned digits are always one less than the digits that are stored in the page XML file. (See the C# example.)C# example
The following example gets the confidence string for the second alternative.string strAltConf = m_oVendorField.get_AltConfidenceString(2)