ExpansionProvider.GetFieldValue(String, String) 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.12.40392

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.

Returns the value of the specified field.

public:
 virtual bool GetFieldValue(System::String ^ field, [Runtime::InteropServices::Out] System::String ^ % value);

 virtual bool GetFieldValue(std::wstring const & field, [Runtime::InteropServices::Out] std::wstring const & & value);

public virtual bool GetFieldValue (string field, out string value);

abstract member GetFieldValue : string * string -> bool
override this.GetFieldValue : string * string -> bool

Public Overridable Function GetFieldValue (field As String, ByRef value As String) As Boolean

Parameters

field: String

[in] A string containing the name of the field for which to get a value.

value: String

[out] A string containing the value of the field.

Returns

Boolean

If there is an expansion session in progress and the specified field exists and contains a value, returns true; otherwise, returns false.

Remarks

A field is a part of the snippet template for which different values can be substituted, possibly from an expansion function.

The base method calls the GetFieldValue method on the IVsExpansionSession object that was obtained in the InsertSpecificExpansion or InsertNamedExpansion methods.

Applies to

Share via