Okapi .NET Library

IUtilitySet.NeedRoot Method 

 [This is preliminary documentation and subject to change.]

Queries whether the current utility needs to have a root defined for a specific input list.

[Visual Basic]
Function NeedRoot( _ 
   ByVal p_nInputList As Integer _ 
) As Boolean
[C#]
bool NeedRoot(
   int p_nInputList
);
[C++]
bool NeedRoot(
   int p_nInputList
);
[JScript]
function NeedRoot(
   int p_nInputList
): bool;

Parameters

p_nInputList
Index of the specified input list. The index is zero-based.

Return Value

True if the current utility requires a root to be set for the specified input list.

Remarks

You can use the SetRoot method to specify the root. GetCurrentUtility

See Also

IUtilitySet Interface | Okapi.Library.Utility Namespace | SetRoot