IVsTextManager.AttemptToCheckOutBufferFromScc2 Method

Article
11/25/2013

Attempts to check out a file from source code control.

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

Syntax

'Declaration
Function AttemptToCheckOutBufferFromScc2 ( _
    pszFileName As String, _
    <OutAttribute> ByRef pfCheckoutSucceeded As Integer, _
    <OutAttribute> ByRef piStatusFlags As Integer _
) As Integer

int AttemptToCheckOutBufferFromScc2(
    string pszFileName,
    out int pfCheckoutSucceeded,
    out int piStatusFlags
)

int AttemptToCheckOutBufferFromScc2(
    [InAttribute] String^ pszFileName, 
    [OutAttribute] int% pfCheckoutSucceeded, 
    [OutAttribute] int% piStatusFlags
)

abstract AttemptToCheckOutBufferFromScc2 : 
        pszFileName:string * 
        pfCheckoutSucceeded:int byref * 
        piStatusFlags:int byref -> int

function AttemptToCheckOutBufferFromScc2(
    pszFileName : String, 
    pfCheckoutSucceeded : int, 
    piStatusFlags : int
) : int

Parameters

pszFileName
Type: System.String

[in] Filename to check out.

pfCheckoutSucceeded
Type: System.Int32%

[out] Returns true if buffer checkout succeeded.

piStatusFlags
Type: System.Int32%

[out]Additional status flags. This is the tagVSQueryEditResult value returned from a call to QueryEditFiles. If you pass in a value of nulla null reference (Nothing in Visual Basic) for this parameter, then a tagVSQueryEditResult flag is not returned.

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

This method is called when the user attempts to open a file that is under source code control. The source code control may prompt the user to respond to information in dialog boxes when this method is called.

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

Share via