This documentation is archived and is not being maintained.

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)

public:
bool IsExcluded(
	String^ localItem, 
	bool isFolder, 
	[OutAttribute] String^% appliedExclusion, 
	[OutAttribute] String^% ignoreFilePath
)

Parameters

localItem
Type: System::String

The local item to check

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

Show: