Effective SourceSafe - shell extension for SourceSafe

• Download source - 75.5 Kb

Introduction

Effective SourceSafe is a shell extension enabling basic SourceSafe functionalities in Windows shell. With this extension you can check in/out your source files directly in Windows Explorer. It has only been tested under Windows 2000/XP with SourceSafe 6.0, but it should work on older versions too. However, overlay icons will require ME or later.

Installation

For installation, type the following command in Start->Run:

regsvr32 x:\path_to_this_file\EssShell.dll

For uninstallation, type the following command in Start->Run:

regsvr32 /u x:\path_to_this_file\EssShell.dll

Then you must restart Windows Explorer by either logoff and login or restarting computer, otherwise the Ess icons won't be loaded by Explorer.

Connects to SourceSafe database

You need to specify a profile (VssShell.ini file) to specify SourceSafe database, and which files to be included for the shell extension. A typical profile looks like:

[Common]
profiles = 1
OverlayIcons = true

[Profile_1]
VSSData = E:\VSSData\srcsafe.ini
User = David Yuheng Zhao
Pwd = 
VSSRoot = $/
LocalRoot = E:\Projects\
Include_1 = *.*
Exclude_1 = *\Debug\*.*
Exclude_2 = *\*Release*\*.*
Exclude_3 = *\Output\*.*
Exclude_4 = *.bsc
Exclude_5 = *.ilk
Exclude_6 = *.obj
Exclude_7 = *.res
Exclude_8 = *.pch
Exclude_9 = *.pdb
Exclude_10 = *.aps
Exclude_11 = *.vssscc
Exclude_12 = *.*~*
Exclude_13 = *.scc
Exclude_14 = dlldata.c
Exclude_15 = *.ncb
Exclude_16 = *.positions
Exclude_17 = *_i.c
Exclude_18 = *_p.c
Exclude_19 = *_h.h
Exclude_20 = *.tmp
Exclude_21 = thumbs.db

You must specify the correct path to the SourceSafe database (VSSData), user name (User) and password (Pwd). Then you also need to specify a project (VSSRoot) from VSS (e.g. $/ or $/my_project/) and the corresponding local path (LocalRoot).

Files to be monitored are defined by "include" and "exclude" rules, the default rules are for Visual C++ projects where compiler generated files are excluded.

The INI file will be reloaded automatically when you save the file.

Usage

If you have given correct parameters in essshell.ini, you should get some additional menu items when you right click any source file in the project folder. Please note that only relevant actions are available:

• Add to source control
• Get latest version
• Check out
• Check in
• Undo check out
• Exclude from source control * (Not implemented yet)
• Delete at source control*
• About ..

Items marked with (*) are only displayed when you hold shift key when you right click at the item. When you hold shift key, (R) may appear on several menu items, then these commands will be performed recursively.

Known issues

• Performance - Windows Explorer may become slower when you enable the overlay icons, which shows whether a file is checked out. You can disable that by setting OverlayIcons to false.
• Use default settings only - The shell extension uses default SourceSafe settings only, and you will be ignored when you get a file which is already checked out. I will work on this when I have time.
• Crash in File Open/Save Dialog - If you browse to a project folder in a file open/save dialog and then close the dialog immediately, the application may crash. The reason is that ESS caches SourceSafe object for about 250 ms before it cleans up. This speeds up the redraw of overlay icons. If you close the window before cleaning, the object will be destroyed at DLL_PROCESS_DETACH and an exception arises. If you are familiar with this kind of problem, please advise me. You can disable overlay icon to avoid this problem, or just wait for a while before closing any open/save dialog.
• Bugs - As the version is only 0.1, some bugs will be expected. Please send me a message here and I will try to figure it out.

Latest version

• Latest version from my site

Freeware

Effective SourceSafe is a freeware, so use it freely. If you like it and find it useful, please tell your friends about it. The latest information will be available here.

Version 0.1

Copyright � Ministars Software & David Y. Zhao 2001-2002.

All rights reserved.