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
'Declaration
Function AttemptToCheckOutBufferFromScc3 ( _
pBuffer As IVsTextBuffer, _
pszFileName As String, _
dwQueryEditFlags As UInteger, _
<OutAttribute> ByRef pbCheckoutSucceeded As Integer, _
<OutAttribute> ByRef piStatusFlags As Integer _
) As Integer
'Usage
Dim instance As IVsTextManager2
Dim pBuffer As IVsTextBuffer
Dim pszFileName As String
Dim dwQueryEditFlags As UInteger
Dim pbCheckoutSucceeded As Integer
Dim piStatusFlags As Integer
Dim returnValue As Integer
returnValue = instance.AttemptToCheckOutBufferFromScc3(pBuffer, _
pszFileName, dwQueryEditFlags, pbCheckoutSucceeded, _
piStatusFlags)
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
)
function AttemptToCheckOutBufferFromScc3(
pBuffer : IVsTextBuffer,
pszFileName : String,
dwQueryEditFlags : uint,
pbCheckoutSucceeded : int,
piStatusFlags : int
) : int
Parameters
pBuffer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer[in] IVsTextBuffer for file.
pszFileName
Type: System.String[in] Name of the file to check out.
dwQueryEditFlags
Type: System.UInt32
pbCheckoutSucceeded
Type: System.Int32%[out] true if checkout succeeded.
piStatusFlags
Type: System.Int32%[out] 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
- 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.