IVsExpansionFunction.FieldChanged Method

Article
03/11/2013

Called when another field in the inserted code snippet is changed.

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

Syntax

'Declaration
Function FieldChanged ( _
    bstrField As String, _
    <OutAttribute> ByRef fRequeryFunction As Integer _
) As Integer

int FieldChanged(
    string bstrField,
    out int fRequeryFunction
)

int FieldChanged(
    [InAttribute] String^ bstrField, 
    [OutAttribute] int% fRequeryFunction
)

abstract FieldChanged : 
        bstrField:string * 
        fRequeryFunction:int byref -> int

function FieldChanged(
    bstrField : String, 
    fRequeryFunction : int
) : int

Parameters

bstrField
Type: System.String
[in] Name of the field that changed.

fRequeryFunction
Type: System.Int32%
[out] Returns non-zero (true) if this expansion function's value has changed and must be re-obtained; otherwise, returns zero (false).

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 textmgr2.idl:

bool IVsExpansionFunction::FieldChanged(
   [in] BSTR bstrField,
   [out] bool *fRequeryFunction
);

This method is called when another field in the code snippet is changed, typically because the user edited the field. If this method sets the fRequeryFunction parameter to non-zero (true), the GetCurrentValue method should be called to fetch the updated value for this expansion function.

.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