IVsTextManager::AttemptToCheckOutBufferFromScc2 Method (String^, Int32, Int32)

Visual Studio 2015

Attempts to check out a file from source code control.

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

Syntax

C++

int AttemptToCheckOutBufferFromScc2(
	String^ pszFileName,
	[OutAttribute] int% pfCheckoutSucceeded,
	[OutAttribute] int% piStatusFlags
)

Parameters

pszFileName: Type: System::String^
[in] Filename to check out.

pfCheckoutSucceeded: Type: System::Int32
[out] Returns true if buffer checkout succeeded.

piStatusFlags: Type: System::Int32
[out]Additional status flags. This is the tagVSQueryEditResult value returned from a call to QueryEditFiles. If you pass in a value of null for this parameter, then a tagVSQueryEditResult flag is not returned.

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 IVsTextManager::AttemptToCheckOutBufferFromScc2(
   [in] const WCHAR *pszFileName,
   [out] BOOL *pfCheckoutSucceeded,
   [out] int *piStatusFlags
);

This method is called when the user attempts to open a file that is under source code control. The source code control may prompt the user to respond to information in dialog boxes when this method is called.