IVsTextManager2.GetBufferSccStatus3 Method
Definition
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.
Determines whether a file is under SCC, and if so, attempts to check it out.
public:
int GetBufferSccStatus3(Microsoft::VisualStudio::TextManager::Interop::IVsTextBuffer ^ pBuffer, System::String ^ pszFileName, [Runtime::InteropServices::Out] int % pbCheckoutSucceeded, [Runtime::InteropServices::Out] int % piStatusFlags);
int GetBufferSccStatus3(Microsoft::VisualStudio::TextManager::Interop::IVsTextBuffer const & pBuffer, std::wstring const & pszFileName, [Runtime::InteropServices::Out] int & pbCheckoutSucceeded, [Runtime::InteropServices::Out] int & piStatusFlags);
public int GetBufferSccStatus3 (Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer pBuffer, string pszFileName, out int pbCheckoutSucceeded, out int piStatusFlags);
abstract member GetBufferSccStatus3 : Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer * string * int * int -> int
Public Function GetBufferSccStatus3 (pBuffer As IVsTextBuffer, pszFileName As String, ByRef pbCheckoutSucceeded As Integer, ByRef piStatusFlags As Integer) As Integer
Parameters
- pBuffer
- IVsTextBuffer
[in] Pointer to the IVsTextBuffer interface.
- pszFileName
- String
[in] File name of interest.
- pbCheckoutSucceeded
- Int32
[out] true if checkout succeeded.
- piStatusFlags
- Int32
[out] Additional status flags, may be null. For more information see tagVSQueryEditResult.
Returns
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.