IVsExpansionSession.EndCurrentExpansion(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Called to indicate the end of the current code snippet insertion process.

public:
 int EndCurrentExpansion(int fLeaveCaret);

public:
 int EndCurrentExpansion(int fLeaveCaret);

int EndCurrentExpansion(int fLeaveCaret);

public int EndCurrentExpansion (int fLeaveCaret);

abstract member EndCurrentExpansion : int -> int

Public Function EndCurrentExpansion (fLeaveCaret As Integer) As Integer

Parameters

fLeaveCaret: Int32

[in] Non-zero (TRUE) if to leave the edit caret where it is; otherwise, zero (FALSE) if the edit caret should be positioned according to the code snippet template.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr2.idl:

HRESULT IVsExpansionSession::EndCurrentExpansion(  
   [in]bool fLeaveCaret  
);

A code snippet template typically marks where the edit caret should be positioned after the snippet has been inserted and the special edit mode is completed. This method is called during the special edit mode when the user types the Enter or ESC keys. If Enter is typed, the fLeaveCaret parameter should be set to non-zero (TRUE) and if ESC is typed, the fLeaveCaret parameter should be set to zero (FALSE). This method positions the caret appropriately in the associated text view before returning.

Applies to

Partager via