ExpansionFunction.GetCurrentValue Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Package
Assembly:
Microsoft.VisualStudio.Package.LanguageService.14.0.dll
Assembly:
Microsoft.VisualStudio.Package.LanguageService.15.0.dll
Package:
Microsoft.VisualStudio.Package.LanguageService.15.0 v17.11.40262

Gets the current value of the expansion function.

Overloads

GetCurrentValue()

Gets the current value of the expansion function as a string.
GetCurrentValue(String, Int32)

Gets the current value of the expansion function.

Remarks

Determines the value of the expansion function by evaluating the arguments and returning an appropriate value.

GetCurrentValue()

Gets the current value of the expansion function as a string.

public:
 abstract System::String ^ GetCurrentValue();
public:
 abstract Platform::String ^ GetCurrentValue();
 abstract std::wstring GetCurrentValue();
public abstract string GetCurrentValue ();
abstract member GetCurrentValue : unit -> string
Public MustOverride Function GetCurrentValue () As String

Returns

String

The current value of the expansion function, otherwise null.

Remarks

You must implement this method in a class derived from the ExpansionFunction class in order to provide a value for an expansion function. Your implementation of this method can call the GetArgument method to obtain values for any arguments the expansion function may have. Returning a null value indicates that the expansion function could not be evaluated (in which case the default value of the field is shown).

Applies to

GetCurrentValue(String, Int32)

Gets the current value of the expansion function.

public:
 virtual int GetCurrentValue([Runtime::InteropServices::Out] System::String ^ % bstrValue, [Runtime::InteropServices::Out] int % hasDefaultValue);
public int GetCurrentValue (out string bstrValue, out int hasDefaultValue);
abstract member GetCurrentValue : string * int -> int
override this.GetCurrentValue : string * int -> int
Public Function GetCurrentValue (ByRef bstrValue As String, ByRef hasDefaultValue As Integer) As Integer

Parameters

bstrValue
String

[out] Returns the value, if it exists, otherwise an empty string.

hasDefaultValue
Int32

[out] Returns true if bstrValue is not null.

Returns

Int32

S_OK.

Implements

GetCurrentValue(String, Int32)

Applies to