ExpansionFunction.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.

Gets the value of the specified field.

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

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

public bool GetFieldValue (string name, out string value);

member this.GetFieldValue : string * string -> bool

Public Function GetFieldValue (name As String, ByRef value As String) As Boolean

Parameters

name: String

[in] The name of the field for which to get a value.

value: String

[out] Returns the requested value or null if the value could not be obtained.

Returns

Boolean

If the value was obtained, returns true; otherwise, returns false.

Remarks

This method is called from the GetArgument method to retrieve the value of a particular field by name. The name is not case-sensitive. You can call this method directly from your implementation of the GetCurrentValue method to obtain an argument by name.

This method calls the GetFieldValue method on the IVsExpansionSession object that is held by the ExpansionProvider object.

Applies to

Partilhar via