IVsTextManager2.GetBufferSccStatus3 Method

Article
11/25/2013

Determines whether a file is under SCC, and if so, attempts to check it out.

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

Syntax

'Declaration
Function GetBufferSccStatus3 ( _
    pBuffer As IVsTextBuffer, _
    pszFileName As String, _
    <OutAttribute> ByRef pbCheckoutSucceeded As Integer, _
    <OutAttribute> ByRef piStatusFlags As Integer _
) As Integer

int GetBufferSccStatus3(
    IVsTextBuffer pBuffer,
    string pszFileName,
    out int pbCheckoutSucceeded,
    out int piStatusFlags
)

int GetBufferSccStatus3(
    [InAttribute] IVsTextBuffer^ pBuffer, 
    [InAttribute] String^ pszFileName, 
    [OutAttribute] int% pbCheckoutSucceeded, 
    [OutAttribute] int% piStatusFlags
)

abstract GetBufferSccStatus3 : 
        pBuffer:IVsTextBuffer * 
        pszFileName:string * 
        pbCheckoutSucceeded:int byref * 
        piStatusFlags:int byref -> int

function GetBufferSccStatus3(
    pBuffer : IVsTextBuffer, 
    pszFileName : String, 
    pbCheckoutSucceeded : int, 
    piStatusFlags : int
) : int

Parameters

pBuffer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer

[in] Pointer to the IVsTextBuffer interface.

pszFileName
Type: System.String

[in] File name of interest.

pbCheckoutSucceeded
Type: System.Int32%

[out] true if checkout succeeded.

piStatusFlags
Type: System.Int32%

[out] Additional status flags, may be nulla null reference (Nothing in Visual Basic). For more information see tagVSQueryEditResult.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextManager2::GetBufferSccStatus3(
   [in] IVsTextBuffer *pBuffer,
   [in] const WCHAR *pszFileName,
   [out] BOOL *pbCheckoutSucceeded,
   [out] int *piStatusFlags
);

GetBufferSccStatus3 and AttemptToCheckOutBufferFromScc3 are the preferred means for interacting with SCC.

.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.

Share via