Partager via


IVsTextManager2.AttemptToCheckOutBufferFromScc3 Method

Attempts to check a file out of SCC.

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

Syntax

'Déclaration
Function AttemptToCheckOutBufferFromScc3 ( _
    pBuffer As IVsTextBuffer, _
    pszFileName As String, _
    dwQueryEditFlags As UInteger, _
    <OutAttribute> ByRef pbCheckoutSucceeded As Integer, _
    <OutAttribute> ByRef piStatusFlags As Integer _
) As Integer
int AttemptToCheckOutBufferFromScc3(
    IVsTextBuffer pBuffer,
    string pszFileName,
    uint dwQueryEditFlags,
    out int pbCheckoutSucceeded,
    out int piStatusFlags
)
int AttemptToCheckOutBufferFromScc3(
    [InAttribute] IVsTextBuffer^ pBuffer, 
    [InAttribute] String^ pszFileName, 
    [InAttribute] unsigned int dwQueryEditFlags, 
    [OutAttribute] int% pbCheckoutSucceeded, 
    [OutAttribute] int% piStatusFlags
)
abstract AttemptToCheckOutBufferFromScc3 : 
        pBuffer:IVsTextBuffer * 
        pszFileName:string * 
        dwQueryEditFlags:uint32 * 
        pbCheckoutSucceeded:int byref * 
        piStatusFlags:int byref -> int 
function AttemptToCheckOutBufferFromScc3(
    pBuffer : IVsTextBuffer, 
    pszFileName : String, 
    dwQueryEditFlags : uint, 
    pbCheckoutSucceeded : int, 
    piStatusFlags : int
) : int

Parameters

  • pszFileName
    Type: System.String
    [in] Name of the file to check out.
  • pbCheckoutSucceeded
    Type: System.Int32%
    [out] true if checkout succeeded.
  • piStatusFlags
    Type: System.Int32%
    [out] Additional status flags, may be nulla null reference (Nothing in Visual Basic). For more information see tagVSQueryEditResult.

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

.NET Framework Security

See Also

Reference

IVsTextManager2 Interface

Microsoft.VisualStudio.TextManager.Interop Namespace