ExpansionFunction.GetFunctionType(UInt32) 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

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 type of the function; that is, what type of value the function returns.

public:
 virtual int GetFunctionType([Runtime::InteropServices::Out] System::UInt32 % pFuncType);

 virtual int GetFunctionType([Runtime::InteropServices::Out] unsigned int & pFuncType);

public virtual int GetFunctionType (out uint pFuncType);

abstract member GetFunctionType : uint32 -> int
override this.GetFunctionType : uint32 -> int

Public Overridable Function GetFunctionType (ByRef pFuncType As UInteger) As Integer

Parameters

pFuncType: UInt32

[out] A value from the _ExpansionFunctionType enumeration specifying the type of the expansion function.

Returns

Int32

If successful, returns S_OK; otherwise, returns an error code.

Implements

GetFunctionType(UInt32)

Remarks

This method determines what is returned from the expansion function: a value or a list. If the expansion function returns a value, then the GetCurrentValue(String, Int32) method is called to obtain that value. If the expansion function returns a list, then the GetListText method is called to obtain a value from the list.

This method is an implementation of the GetFunctionType method on the IVsExpansionFunction interface.

The base method returns eft_Value if the expansion function returns a single value or eft_List if the expansion function returns a list of values. The base method always returns a success code of S_OK.

Applies to

Share via