Checking out files

*Prerequisite: If this is your first time checking out files to edit, make sure you have downloaded the server files to your local working folder; (this is accomplished using the Teamprise Get Latest task, and usually occurs right after you have set your working folder mappings in your TFS workspace.) To confirm that the files you want to edit are in your local working folder, check the Source Control view: If the Team directory is dimmed, then you have not yet performed a Get Latest and files are not in your local directory. If you attempt to check out a file that is not yet in your local repository the check out option in the popup menu will be disabled.

Understanding check-outs

When you want to edit a file in TFS source control you must first let the server know you are taking this action. A check out accomplishes this. By checking out a file, you are in effect notifying the server that you have an edit pending on a source controlled file; the server responds by marking it writeable and thus allows you to make changes to the file in your workspace. The server version remains the same.

Note: It's important to remember that checking out a file does not retrieve the latest version in the source control repository, it simply tells the server you are working on the version last checked in to your workspace. To edit using the latest version in the source control repository, always perform a Get Latest Version before checking a file out to edit. You can set a global preference to do this automatically. For more information see, Setting Teamprise Preferences.

To check out a file:

In the Source Control File view right-click a file or folder you want to edit and select Check Out For Edit...
Note: You can check out more than one file or folder at a time by holding down the Ctrl key to select files.
The Check Out dialog lists the Name of the file(s) or folder you want to check-out and the path to the local Folder. The check box is checked by default; if you uncheck a checkbox, that file will not be checked out.

When checking out files to edit, you can choose between four lock types:
- Unchanged: Any existing lock will remain. If the file is already locked in your workspace, it will remain locked. If it is not locked, now new lock will be acquired.
- None: No lock will be held. If the file is already locked in your workspace, it will be unlocked. This will allow other members on your team to check out and check in the file while you have the file checked out.
- Check Out: Other members on your team will be prevented from checking out the file.
- Check In: Other members on your team will be able to check out the file, but will be prevented from checking their changes in.
You may change the default lock modes with a global preference setting. For more information see, Setting Teamprise Preferences.
Note: Binary files such as jpgs, pdfs, mpgs, etc. are automatically locked during a check out because they are non-mergeable file types.

Once you have selected files to be checked out and selected a lock type, click OK.
The Teamprise Pending Changes | Source Files channel displays all checked-out files. If you quit out of Teamprise and launch it again later, these files will still appear in the view and will remain until files are checked in or until you perform an undo, or shelve action.

Note: Remember the source code repository is a shared resource. It's a good practice to check-in all files at the end of each working day regardless of the selected lock type so others can have access to your changes.

Troubleshooting

If a file is pending an edit (i.e., is checked out) by another user, the File pane displays the name of the user editing the file, the type of pending change, (e.g., add, delete, edit, etc.) and whether or not the file is locked (i.e., is writeable to other users). For more details on the Source control view and status details, see User Guide section, Source Control View.

When you attempt to check out a file already checked out by another team member you will receive a warning in the Console view:

Warning: There are other pending changes against the item. [$/team_proj/filename]
  Edit in workspace_name;TFS_name\user

If the file is not locked you will be able to edit, but you may have a conflict checking in. See the User Guide section, Resolving version conflicts for troubleshooting check-in conflicts.

If a file is checked-out (and locked) by another team member, you will be unable to check out the file. Teamprise will return the following message in the Console:

The item $/teamp_proj/filename is locked for check-out by 
TFS_server_name\user in workspace workspace_name.

Depending on the type of lock you may still be able to work on the file in your local workspace, but you will not be able to check it in until the the lock has been released and conflicts resolved. For more information see the User Guide section, View Pending Changes in other Workspaces.