Share via


LocalItemExclusionEvaluator.IsExcluded Method (String, Boolean, String%, String%)

Check the provided local item against the LocalItemExclusionEvaluator to see whether it should be excluded from addition to version control. If the item is excluded, the appliedExclusion and ignoreFilePath out parameters will be set to provide additional information about why the item was excluded.

Namespace:  Microsoft.TeamFoundation.VersionControl.Client
Assembly:  Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

Syntax

'Declaration
Public Function IsExcluded ( _
    localItem As String, _
    isFolder As Boolean, _
    <OutAttribute> ByRef appliedExclusion As String, _
    <OutAttribute> ByRef ignoreFilePath As String _
) As Boolean
public bool IsExcluded(
    string localItem,
    bool isFolder,
    out string appliedExclusion,
    out string ignoreFilePath
)
public:
bool IsExcluded(
    String^ localItem, 
    bool isFolder, 
    [OutAttribute] String^% appliedExclusion, 
    [OutAttribute] String^% ignoreFilePath
)
member IsExcluded : 
        localItem:string * 
        isFolder:bool * 
        appliedExclusion:string byref * 
        ignoreFilePath:string byref -> bool
public function IsExcluded(
    localItem : String, 
    isFolder : boolean, 
    appliedExclusion : String, 
    ignoreFilePath : String
) : boolean

Parameters

  • isFolder
    Type: System.Boolean

    True if the local item to check is a folder; false otherwise

  • appliedExclusion
    Type: System.String%

    [out] If the item is excluded, the exclusion which was applied

  • ignoreFilePath
    Type: System.String%

    [out] If the item is excluded, the name of the ignore file on disk which contains the applied exclusion. If the applied exclusion came from the global exclusion list for the Team Project Collection, the value is the empty string.

Return Value

Type: System.Boolean
True if the item is excluded; false otherwise

.NET Framework Security

See Also

Reference

LocalItemExclusionEvaluator Class

IsExcluded Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace