IVsTaskItem3.GetEnumValue Method

Given a column field and value index, returns the indexed value for this task and column.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function GetEnumValue ( _
    iField As Integer, _
    iValue As Integer, _
    <OutAttribute> ByRef pvarValue As Object, _
    <OutAttribute> ByRef pbstrAccessibilityName As String _
) As Integer
'Usage
Dim instance As IVsTaskItem3
Dim iField As Integer
Dim iValue As Integer
Dim pvarValue As Object
Dim pbstrAccessibilityName As String
Dim returnValue As Integer

returnValue = instance.GetEnumValue(iField, _
    iValue, pvarValue, pbstrAccessibilityName)

int GetEnumValue(
    int iField,
    int iValue,
    out Object pvarValue,
    out string pbstrAccessibilityName
)

int GetEnumValue(
    [InAttribute] int iField, 
    [InAttribute] int iValue, 
    [OutAttribute] Object^% pvarValue, 
    [OutAttribute] String^% pbstrAccessibilityName
)

abstract GetEnumValue : 
        iField:int * 
        iValue:int * 
        pvarValue:Object byref * 
        pbstrAccessibilityName:string byref -> int

function GetEnumValue(
    iField : int, 
    iValue : int, 
    pvarValue : Object, 
    pbstrAccessibilityName : String
) : int

Parameters

iField
Type: System.Int32
[In] An integer value containing the column field.

iValue
Type: System.Int32
[In] An integer value index.

pvarValue
Type: System.Object%
[Out] A pointer to a value of type VARIANT.

pbstrAccessibilityName
Type: System.String%
[out] A pointer to a string containing the Accessibility Name.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

pbstrAccessibilityName is the descriptive text exposed to accessibility for this value. If *ptvtType != TVT_IMAGE, it may be left blank; in that case, the text of the value itself will be used.

COM Signature

From vsshell80.idl:

HRESULT IVsTaskItem3::GetEnumValue(
   [in] int iField, 
   [in] int iValue, 
   [out] VARIANT* pvarValue,
   [out] BSTR* pbstrAccessibilityName
);

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