Object Model: LinktabRuleCollection.Filter

LinktabRuleCollection.Filter

Description

Returns a subset of the collection defined by the RuleKind passed in argument.

C# Syntax

LinktabRuleCollection LinktabRuleCollection.Filter( siRuleKind in_siRuleKind );

Scripting Syntax

oReturn = LinktabRuleCollection.Filter( RuleKind );

Return Value

LinktabRuleCollection (contains a subset of linktab rules)

Parameters

Parameter	Type	Description
RuleKind	siRuleKind	Specifies the type of rules to be returned.

Examples

VBScript Example

set l_linktab = xsiutils.Linktab
        if l_linktab.Filename(szFileName) = "True" then
                ' Get a LinktabRuleCollection from the Linktab object
                Set l_rulesColl =  l_linktab.Rules 
                ' Get a subset of linktab rules.
                Set l_subRulesColl = l_rulesColl.Filter(siRuleKind_NT2Unix)
                If l_subRulesColl.Count > 0 Then
                        For i=0 to l_subRulesColl.Count-1
                                LogMessage  l_subRulesColl(i)
                        Next
                End if
        else
                LogMessage "Linktab file not set"
        End if