IVsSccEnlistmentPathTranslation Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Used by the solution to translate project paths.

public interface class IVsSccEnlistmentPathTranslation

public interface class IVsSccEnlistmentPathTranslation

__interface IVsSccEnlistmentPathTranslation

[System.Runtime.InteropServices.Guid("53544C4D-01F8-11D0-8E5E-00A0C911005A")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsSccEnlistmentPathTranslation

[<System.Runtime.InteropServices.Guid("53544C4D-01F8-11D0-8E5E-00A0C911005A")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsSccEnlistmentPathTranslation = interface

Public Interface IVsSccEnlistmentPathTranslation

Attributes

GuidAttribute InterfaceTypeAttribute

Remarks

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.

Methods

TranslateEnlistmentPathToProjectPath(String, String)	Translates a physical project path to a (possibly) virtual project path.
TranslateProjectPathToEnlistmentPath(String, String, String)	Translates a possibly virtual project path to a local path and an enlistment physical path.