IVsTextManager.AttemptToCheckOutBufferFromScc2(String, Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attempts to check out a file from source code control.

public:
 int AttemptToCheckOutBufferFromScc2(System::String ^ pszFileName, [Runtime::InteropServices::Out] int % pfCheckoutSucceeded, [Runtime::InteropServices::Out] int % piStatusFlags);

int AttemptToCheckOutBufferFromScc2(std::wstring const & pszFileName, [Runtime::InteropServices::Out] int & pfCheckoutSucceeded, [Runtime::InteropServices::Out] int & piStatusFlags);

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

abstract member AttemptToCheckOutBufferFromScc2 : string * int * int -> int

Public Function AttemptToCheckOutBufferFromScc2 (pszFileName As String, ByRef pfCheckoutSucceeded As Integer, ByRef piStatusFlags As Integer) As Integer

Parameters

pszFileName: String

[in] Filename to check out.

pfCheckoutSucceeded: Int32

[out] Returns true if buffer checkout succeeded.

piStatusFlags: 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

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.

Applies to

Share via