Check-Out File (see also)

The check-out operation is equivalent to a get followed by a lock, except that a check-out operation will make the work file read/write by default whereas a get will leave the work file read-only. Checking out a file is necessary when lock-checking and the PROTECTWORKFILE attribute are enabled. It enables you to work on the indicated revision and places a lock on that revision so that no one else may make changes to the same revision.

As with the get operation, you can easily check out a file by selecting it and clicking the Check-out File toolbar button. By default, the Check-out File dialog will retrieve and lock the most recent revision in the archive. You may also check out older revisions, by the revision number in the case of single file operations, and by date or label for both file and project-level operations.

Check-out File Dialog

This is the dialog which appears when you click the Check-out File toolbar button.

Check-out File Dialog

You can alter the default settings on this dialog using the Check-out Dialog tab of the User Preferences dialog.

Each field has the following meanings:

Revision:

This drop down list shows you all the revisions in the selected QVCS archive. Selecting the "default revision" selection will check out the default revision from the QVCS archive. Selecting any other revision will check out the selected revision instead. This field is disabled for multiple file operations.

Into the work file:

This edit field identifies the full name of the work file that QVCS will write to or create as a result of the check-out operation. You can edit this manually to alter the work file name, or use the [...] button to select a work file name from a file selection dialog.

Comment:

If you want to enter a comment describing why you are checking out the file, you enter that comment here. That comment will later be used as the default check-in comment when you later check this file in.

Expand Keywords

If you leave this check box alone, QVCS will use the QVCS archive's Expand Keywords attribute to determine whether to expand keywords as it fetches the work file. If you clear this check box, QVCS will not expand keywords, and if you set this check box, QVCS will expand keywords, both regardless of the archive's Expand Keywords attribute setting.

By Date/Time

Clicking the "By Date/Time" check box will disable the revision selection list and the label list box, clear the "By Label" check box, and enable the edit box used to enter the date/time. If "By Date/Time" is enabled, you must define the date/time in the format described next to the date/time edit box (this format depends on your current locale). A check-out by date/time will retrieve the revision that was 'active' at that date/time.

By Label

Enabling this check box will disable the revision selection list, and enable the Labels list box. When the "By Label" check box is enabled, you're required to select the label associated with the revision you wish to check out. When performing a project level check-out operation, the Labels list box is not populated until you enable the "By Label" check box. After you enable the check box, QWin will scan all the project's QVCS archive files for labels, and use that complete set of labels to provide the selection list from which you can choose. For large projects, scanning for labels can take some time.


Toolbar Operations
GetCheck OutAddCheck InUndo Check-outLockLabelFile GroupsSort RevisionsFilter RevisionsFilter FilesCompare


See also: the corresponding qget command line utility.