IVsSccEnlistmentPathTranslation Interface
Collapse the table of content
Expand the table of content

IVsSccEnlistmentPathTranslation Interface


Used by the solution to translate project paths.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

public interface IVsSccEnlistmentPathTranslation

System_CAPS_pubmethodTranslateEnlistmentPathToProjectPath(String, String)

Translates a physical project path to a (possibly) virtual project path.

System_CAPS_pubmethodTranslateProjectPathToEnlistmentPath(String, String, String)

Translates a possibly virtual project path to a local path and an enlistment physical path.

An "enlistment" means the local working copy of a project as pulled from source control. Because projects can have virtual paths (for example, relative to a Web URL), a mechanism is needed to translate between those virtual paths and the location where the files exist locally. This mechanism is expressed with the IVsSccEnlistmentPathTranslation interface.

Notes to Implementers:

This interface is implemented by the source control package if it supports the idea of virtual folders for projects. If this interface is not implemented, the user must manually check out files, and check in files, and move those files to the appropriate physical location that corresponds to the virtual folder in the project.

Notes to Callers:

This interface is used by a solution in order to translate virtual paths (as displayed in the solution) to physical locations and back.

Return to top
© 2016 Microsoft