ExpansionProvider.GetFieldValue(String, String) Method

Definition

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

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