IVsTextManager.GetBufferSccStatus2 Method

Article
08/01/2012

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

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

Syntax

'Déclaration
Function GetBufferSccStatus2 ( _
    pszFileName As String, _
    <OutAttribute> ByRef pbNonEditable As Integer, _
    <OutAttribute> ByRef piStatusFlags As Integer _
) As Integer

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

int GetBufferSccStatus2(
    [InAttribute] String^ pszFileName, 
    [OutAttribute] int% pbNonEditable, 
    [OutAttribute] int% piStatusFlags
)

abstract GetBufferSccStatus2 : 
        pszFileName:string * 
        pbNonEditable:int byref * 
        piStatusFlags:int byref -> int

function GetBufferSccStatus2(
    pszFileName : String, 
    pbNonEditable : int, 
    piStatusFlags : int
) : int

Parameters

pszFileName
Type: System.String
[in] Filename of interest.

pbNonEditable
Type: System.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
Type: System.Int32%
[out] Returns additional status flags. This is the tagVSQueryEditResult value returned from QueryEditFiles. Pass in a value of nulla null reference (Nothing in Visual Basic) for this parameter if you do not want the return value.

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:

HRESULT IVsTextManager::GetBufferSccStatus2(
   [in] const WCHAR *pszFileName,
   [out] BOOL *pbNonEditable,
   [out] int *piStatusFlags
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via