IVsTextManager.AttemptToCheckOutBufferFromScc2(String, Int32, Int32) IVsTextManager.AttemptToCheckOutBufferFromScc2(String, Int32, Int32) IVsTextManager.AttemptToCheckOutBufferFromScc2(String, Int32, Int32) Method

Definition

Attempts to check out a file from source code control.

public int AttemptToCheckOutBufferFromScc2 (string pszFileName, out int pfCheckoutSucceeded, out int piStatusFlags);
abstract member AttemptToCheckOutBufferFromScc2 : string *  *  -> int
Public Function AttemptToCheckOutBufferFromScc2 (pszFileName As String, ByRef pfCheckoutSucceeded As Integer, ByRef piStatusFlags As Integer) As Integer
Parameters
pszFileName
String String String

[in] Filename to check out.

pfCheckoutSucceeded
Int32 Int32 Int32

[out] Returns true if buffer checkout succeeded.

piStatusFlags
Int32 Int32 Int32

[out]Additional status flags. This is the tagVSQueryEditResult value returned from a call to QueryEditFiles(UInt32, Int32, String[], UInt32[], VSQEQS_FILE_ATTRIBUTE_DATA[], UInt32, UInt32). If you pass in a value of null for this parameter, then a tagVSQueryEditResult flag is not returned.

Returns

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.

Applies to