IVsTextManager2.AttemptToCheckOutBufferFromScc3 Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attempts to check a file out of SCC.

public:
 int AttemptToCheckOutBufferFromScc3(Microsoft::VisualStudio::TextManager::Interop::IVsTextBuffer ^ pBuffer, System::String ^ pszFileName, System::UInt32 dwQueryEditFlags, [Runtime::InteropServices::Out] int % pbCheckoutSucceeded, [Runtime::InteropServices::Out] int % piStatusFlags);

int AttemptToCheckOutBufferFromScc3(Microsoft::VisualStudio::TextManager::Interop::IVsTextBuffer const & pBuffer, std::wstring const & pszFileName, unsigned int dwQueryEditFlags, [Runtime::InteropServices::Out] int & pbCheckoutSucceeded, [Runtime::InteropServices::Out] int & piStatusFlags);

public int AttemptToCheckOutBufferFromScc3 (Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer pBuffer, string pszFileName, uint dwQueryEditFlags, out int pbCheckoutSucceeded, out int piStatusFlags);

abstract member AttemptToCheckOutBufferFromScc3 : Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer * string * uint32 * int * int -> int

Public Function AttemptToCheckOutBufferFromScc3 (pBuffer As IVsTextBuffer, pszFileName As String, dwQueryEditFlags As UInteger, ByRef pbCheckoutSucceeded As Integer, ByRef piStatusFlags As Integer) As Integer

Parameters

pBuffer: IVsTextBuffer

[in] The text buffer for the file.

pszFileName: String

[in] Name of the file to check out.

dwQueryEditFlags: UInt32

Flags determining how file is editable, see tagVSQueryEditResult.

pbCheckoutSucceeded: Int32

[out] true if checkout succeeded.

piStatusFlags: Int32

[out] Additional status flags, may be null. For more information see tagVSQueryEditResult.

Returns

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

Applies to