IVsTextManager2::GetBufferSccStatus3 Method (IVsTextBuffer^, String^, Int32, Int32)

Visual Studio 2015

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

C++

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

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

C++

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.