Okapi .NET Library

IFilter.EditSettings Method 

 [This is preliminary documentation and subject to change.]

Edits a specified parameters file for the filter.

[Visual Basic]
Function EditSettings( _ 
   ByVal p_sFilterSettings As String, _ 
   ByVal p_bNew As Boolean _ 
) As Boolean
[C#]
bool EditSettings(
   string p_sFilterSettings,
   bool p_bNew
);
[C++]
bool EditSettings(
   String* p_sFilterSettings,
   bool p_bNew
);
[JScript]
function EditSettings(
   String p_sFilterSettings,
   bool p_bNew
): bool;

Parameters

p_sFilterSettings
Filter settings string. See LoadSettings for the string format.
p_bNew
True if it is a new file, false otherwise.

Return Value

True if the edit was succesful, false if the user cancels the edit or if an error occurs.

See Also

IFilter Interface | Okapi.Library.Filter Namespace