SetOptionWithString

<< SetOptionsWithFile | Back to Salience 6 python Index | setOption_TaggingThreshold >>

Summary

Sets one or more options via a specially formatted string. This is an alternative to the setOption functions which requires you to programmatically define your option settings. You can also use SetOptionsWithFile to load options from an in memory string. Refer to Options documentation for the available options that may be set and their purpose.
This method provides a wrapper around the underlying C API method lxaSetSalienceOptionWithString.

Syntax

salience6.setOptionWithString(oSession, sOptionString, sConfigurationID)

Parameters

oSession A SalienceSession object previously created via openSession
sOptionString Option configuration string
sConfigurationID Character string specifying a unique identifier for this configuration

Returns

If successful, returns 0.

Option String Format

Each line in the string sets one option, and the format is "<option name>"<tab><option value>. The quotes around the option name are required. If the option value is a string that should be double quoted as well. The name of each option is available on the Options page.

Example Option String

"Tagging Threshold" 50
"Lists and Tables" 1
"User Entity List" "C:/Salience/user.dat"

<< SetOptionsWithFile | Back to Salience 6 python Index | setOption_TaggingThreshold >>