Properties Command

TFS 2017 | TFS 2015 | TFS 2013

Visual Studio 2019 | Visual Studio 2017 | Visual Studio 2015 | Visual Studio 2013

The properties command displays information about items under version control.

Prerequisites

To use the properties command, you must have the Read permission set to Allow for all specified files and folders. For more information, see Default TFVC permissions.

Syntax

tf properties [/collection:TeamProjectCollectionUrl] [/recursive] [/login:username,[password]]
itemspec [/version:versionspec] [/workspace] 

Parameters

Argument

Argument

Description


TeamProjectCollectionUrl

The URL of the project collection that contains the items for which you want to display properties (for example, http://myserver:8080/tfs/DefaultCollection).

Itemspec

Identifies the files and folders that are specified for property retrieval.

For more information about how Visual Studio Team Foundation Server parses itemspecs to determine which items are within scope, see Use Team Foundation version control commands, Use options to modify how a command functions.

Note

You can specify more than one Itemspec argument.

Versionspec

Provides a value such as C3 for the /version option. For more information about how Team Foundation Server parses a version specification to determine which items are within its scope, see Use Team Foundation version control commands.

username

Provides a value to the /login option. You can specify a username value as either Domain<em>UserName or UserName.

Option

Option Description
/recursive Displays all files and subfolders of a folder.
/version Specifies the version of the file to open for viewing the properties on.
/workspace Indicates the workspace to be used when displaying the "local" properties (such as location on disk).
/collection Specifies the project collection.
/login Specifies the user name and password to authenticate the user with Team Foundation Server.

Remarks

The properties command displays several pieces of information about a version-controlled item. Local and server information is listed separately.

Property Name

Description

Local path

Indicates the local path of the workspace folder for the specified item.

Changeset

Indicates the version number of the file or folder that was last retrieved to the current workspace using the Get Command.

Change

Indicates where a change is pending.

Type

Indicates the item type, for example file.

Server path

Indicates the full path of the item on the version control server.

Changeset

Indicates the version number of the item.

Deletion ID

If the item is deleted, the deletion identification; otherwise 0.

Lock

Indicates the type of lock.

  • Checkin Check in is not permitted for the file.
  • Checkout Check out in not permitted for the file.
  • None A lock is not set. For more information, see Lock Command.

Lock Owner

Indicates the person who set a check-in lock.

Last modified

Indicates the date and time stamp for when the item was last modified.

Type

Indicates the item type, for example file.

File Type

Displays the file type encoding. For example, Windows-1252.

Size

Indicates the size of the file in bytes.

For more information on how to find the tf command-line utility, see Use Team Foundation version control commands.

Examples

The following example displays properties information about the file 314.cs.

c:\projects>tf properties 314.cs

The following example displays the properties of the working folder c:\projects\objects.

c:\projects>tf properties objects