IVsTaskItem3.GetTipText Method

Returns the tip text for the given field. If this method fails or returns an empty string, the task list will use the text of the item itself (if any) or the accessibility name as the tip text.

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

Syntax

‘선언
Function GetTipText ( _
    iField As Integer, _
    <OutAttribute> ByRef pbstrTipText As String _
) As Integer
‘사용 방법
Dim instance As IVsTaskItem3
Dim iField As Integer
Dim pbstrTipText As String
Dim returnValue As Integer

returnValue = instance.GetTipText(iField, _
    pbstrTipText)
int GetTipText(
    int iField,
    out string pbstrTipText
)
int GetTipText(
    [InAttribute] int iField, 
    [OutAttribute] String^% pbstrTipText
)
abstract GetTipText : 
        iField:int * 
        pbstrTipText:string byref -> int 
function GetTipText(
    iField : int, 
    pbstrTipText : String
) : int

Parameters

  • iField
    Type: System.Int32
    [In] An integer value representing the field column to use for the Tip Text.
  • pbstrTipText
    Type: System.String%
    [Out] A pointer to a string containing the Tip Text.

Return Value

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsTaskItem3::GetTipText(
   [in] int iField, 
   [out] BSTR* pbstrTipText
);

.NET Framework Security

See Also

Reference

IVsTaskItem3 Interface

IVsTaskItem3 Members

Microsoft.VisualStudio.Shell.Interop Namespace