[This is preliminary documentation and subject to change.]

Sets the value for the specified option of the current utility.

[Visual Basic]
Sub SetOption( _ 
   ByVal p_sName As String, _ 
   ByVal p_sValue As String _ 
)
[C#]
void SetOption(
   string p_sName,
   string p_sValue
);
[C++]
void SetOption(
   String* p_sName,
   String* p_sValue
);
[JScript]
function SetOption(
   String p_sName,
   String p_sValue
);

Parameters

p_sName

Name of the option to set. This name is not case sensitive.

p_sValue

The string representation of the value.

Remarks

The value of must be compatible with XML 1.0. That is that no characters prohibited in XML 1.0 are present in the string. The string does not need to be escaped for XML.

If p_sValue is a null reference (Nothing in Visual Basic) or empty, the option is set to an empty string.

See Also

IUtilitySet Interface | Okapi.Library.Utility Namespace | SetCurrentUtility | HasOptions | GetOptions | SetDefaultOptions | EditOptions

---