IVsTextManager2::AttemptToCheckOutBufferFromScc3 Method (IVsTextBuffer^, String^, UInt32, Int32, Int32)

Visual Studio 2015

Attempts to check a file out of SCC.

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

Syntax

C++

int AttemptToCheckOutBufferFromScc3(
	IVsTextBuffer^ pBuffer,
	String^ pszFileName,
	unsigned int dwQueryEditFlags,
	[OutAttribute] int% pbCheckoutSucceeded,
	[OutAttribute] int% piStatusFlags
)

Parameters

pBuffer: Type: Microsoft.VisualStudio.TextManager.Interop::IVsTextBuffer^
[in] The text buffer for the file.

pszFileName: Type: System::String^
[in] Name of the file to check out.

dwQueryEditFlags: Type: System::UInt32
Flags determining how file is editable, see T:Microsoft.VisualStudio.Shell.Interop. tagVSQueryEditResult.

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::AttemptToCheckOutBufferFromScc3(
   [in] IVsTextBuffer *pBuffer,
   [in] const WCHAR *pszFileName,
   [out] BOOL *pbCheckoutSucceeded,
   [out] int *piStatusFlags
);

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