Okapi .NET Library

IFilter.GetVariantDescription Method 

 [This is preliminary documentation and subject to change.]

Gets the description of a specified variant of the filter.

[Visual Basic]
Function GetVariantDescription( _ 
   ByVal p_nIndex As Integer _ 
) As String
[C#]
string GetVariantDescription(
   int p_nIndex
);
[C++]
String* GetVariantDescription(
   int p_nIndex
);
[JScript]
function GetVariantDescription(
   int p_nIndex
): String;

Parameters

p_nIndex
Index of the variant. The value must be between 0 and the value returned by GetVariantCount - 1.

Return Value

The short description of the specified variant.

See Also

IFilter Interface | Okapi.Library.Filter Namespace