IVsTextManager.GetBufferSccStatus2(String, Int32, Int32) Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Returns information on whether a buffer is under source code control and, if so, whether the file is checked in.

public:
 int GetBufferSccStatus2(System::String ^ pszFileName, [Runtime::InteropServices::Out] int % pbNonEditable, [Runtime::InteropServices::Out] int % piStatusFlags);

int GetBufferSccStatus2(std::wstring const & pszFileName, [Runtime::InteropServices::Out] int & pbNonEditable, [Runtime::InteropServices::Out] int & piStatusFlags);

public int GetBufferSccStatus2 (string pszFileName, out int pbNonEditable, out int piStatusFlags);

abstract member GetBufferSccStatus2 : string * int * int -> int

Public Function GetBufferSccStatus2 (pszFileName As String, ByRef pbNonEditable As Integer, ByRef piStatusFlags As Integer) As Integer

Parameters

pszFileName

String

[in] Filename of interest.

pbNonEditable

Int32

[out] If true, then the file can not be modified (for example, if the file is under source control and checked in). If false, then the file can be edited.)

piStatusFlags

Int32

[out] Returns additional status flags. This is the tagVSQueryEditResult value returned from QueryEditFiles(UInt32, Int32, String[], UInt32[], VSQEQS_FILE_ATTRIBUTE_DATA[], UInt32, UInt32). Pass in a value of null for this parameter if you do not want the return value.

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