IVsSccProjectProviderBinding.TranslateEnlistmentPath Method

Article
04/29/2015

Translates an enlistment path into a displayable path.

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

Syntax

'Declaration
Function TranslateEnlistmentPath ( _
    lpszPath As String, _
    <OutAttribute> ByRef pfAlternateIsDisplay As Integer, _
    <OutAttribute> ByRef pbstrAlternatePath As String _
) As Integer

int TranslateEnlistmentPath(
    string lpszPath,
    out int pfAlternateIsDisplay,
    out string pbstrAlternatePath
)

int TranslateEnlistmentPath(
    [InAttribute] String^ lpszPath, 
    [OutAttribute] int% pfAlternateIsDisplay, 
    [OutAttribute] String^% pbstrAlternatePath
)

abstract TranslateEnlistmentPath : 
        lpszPath:string * 
        pfAlternateIsDisplay:int byref * 
        pbstrAlternatePath:string byref -> int

function TranslateEnlistmentPath(
    lpszPath : String, 
    pfAlternateIsDisplay : int, 
    pbstrAlternatePath : String
) : int

Parameters

lpszPath
Type: String

[in] The enlistment path (a local path) to be translated.

pfAlternateIsDisplay
Type: Int32%

[out] Returns true (nonzero) if the alternate path is the preferred path for display; otherwise, returns false (0) if the path supplied as lpszPath is preferred for display.

pbstrAlternatePath
Type: String%

[out] Returns an alternate path that can be used for display if pfAlternatedIsDisplay is true.

Note The alternate path should never be empty: if an alternate path is not needed, then this method should return the original path as the alternate path.

Return Value

Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code. A typical error can be E_NOTIMPL if the project does not use dual paths.

Remarks

COM Signature

From ivssccprojectproviderbinding.idl

HRESULT TranslateEnlistmentPath(
   [in] LPCOLESTR lpszPath,
   [out] BOOL * pfAlternateIsDisplay,
   [out] BSTR * pbstrAlternatePath
);

The enlistment path might be in one or two forms, depending on the needs of the project.

Projects are allowed to have two different but synonymous paths: local and cache. The project's Version API (VAPI) source control package must treat both paths as identical (as Visual Studio may pass in either one). TranslateEnlistmentPath handles this translation for the source control package.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via