Okapi .NET Library

IFilter.GetIdentifier Method 

 [This is preliminary documentation and subject to change.]

Gets the identifier of the filter.

[Visual Basic]
Function GetIdentifier() As String
[C#]
string GetIdentifier();
[C++]
String* GetIdentifier();
[JScript]
function GetIdentifier(): String;

Return Value

The string that identify the filter.

Remarks

Use this method to retrieve the unique identifier of the filter. The value is case-sensitive.

The identifier used in the name of the parameters files, along with other parts. For example, in okp_myfilter@Test.fprm the okp_myfilter is the filter identifier.

See Also

IFilter Interface | Okapi.Library.Filter Namespace | LoadSettings