CleanCode logo

CleanCode PowerShell Libraries v1.2.08 API: CleanCode » TfsTools » Get-TfsDetails





Retrieves TFS details about each file and folder.


Get-TfsDetails [[-Path] <String>] [<CommonParameters>]


From the output (see example), you can tell things like:
* whether your workspace copy is current (IsLatest true or false).
* whether an item is completely new (IsInWorkspace will be False and VersionLocal will be 0).
* whether an item is simply out-of-date (VersionLatest will be larger than VersionLocal).
* whether you have edited the local item (ChangeType will be Edit rather than None).

Refer to Get-StaleTfsFiles to limit the output to stale items. Refer to Get-StaleTfsFolders or Get-StaleTfsProjects to see a summary of stale files.

This is actually a decorator around the TFS PowerTools Get-TfsItemProperty cmdlet, automatically scanning the whole subtree and separating out two additional properties, the file name and the parent path. This cmdlet is the workhorse for other cmdlets in this module.


-Path <String>
        The root of the subtree to check.
        If omitted, uses the current directory.

        Required?                    false
        Position?                    1
        Default value                .
        Accept pipeline input?       false
        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer and OutVariable. For more information, see 
        about_CommonParameters ( 


None. You cannot pipe objects to Get-TfsDetails.


Array of PSCustomObjects (similar to Microsoft.TeamFoundation.VersionControl.Client.ExtendedItem).


        This function is part of the CleanCode toolbox

        Since CleanCode 1.2.06.


-------------------------- EXAMPLE 1 --------------------------

PS>cd Project; Get-TfsDetails | Format-Table -AutoSize

Tabular output will typically look better by piping to Format-Table as shown.

        Name                 IsInWorkspace IsLatest ChangeType HasOtherPendingChange IsBranch VersionLatest VersionLocal ParentPath
        ----                 ------------- -------- ---------- --------------------- -------- ------------- ------------ ----------
        Some.Folder                  False    False       None                 False    False         18275            0 $\Development\MyRoot.Dev...
        Some.Other.Folder            False     True       None                 False    False         18102        18102 $\Development\MyRoot.Dev...
        NetworkAdmin.csproj           True    False       None                 False    False         18097         2177 $\Development\MyRoot.Dev...
        AssemblyInfo.cs               True     True       None                 False    False         18097        18097 $\Development\MyRoot.Dev...
        ConnectionDialog.cs           True    False       None                 False    False         18097         1879 $\Development\MyRoot.Dev...


This documentation set was created with CleanCode's DocTreeGenerator.

Valid XHTML 1.0!Valid CSS!Get CleanCode at Fast, secure and Free Open Source software downloads
Copyright © 2001-2015 Michael Sorens • Contact usPrivacy Policy
Usage governed by Mozilla Public License 1.1 and CleanCode Courtesy License
CleanCode -- The Website for Clean DesignRevised 2015.12.16