ExpansionFunction.GetFunctionType Method

Article
2013-03-06

Gets the type of the function; that is, what type of value the function returns.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Public Overridable Function GetFunctionType ( _
    <OutAttribute> ByRef pFuncType As UInteger _
) As Integer

public virtual int GetFunctionType(
    out uint pFuncType
)

public:
virtual int GetFunctionType(
    [OutAttribute] unsigned int% pFuncType
)

abstract GetFunctionType : 
        pFuncType:uint32 byref -> int 
override GetFunctionType : 
        pFuncType:uint32 byref -> int

public function GetFunctionType(
    pFuncType : uint
) : int

Parameters

pFuncType
Type: System.UInt32%
[out] A value from the _ExpansionFunctionType enumeration specifying the type of the expansion function.

Return Value

Type: System.Int32
If successful, returns S_OK; otherwise, returns an error code.

Implements

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via