IVsTaskItem3.GetTipText(Int32, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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.

public:
 int GetTipText(int iField, [Runtime::InteropServices::Out] System::String ^ % pbstrTipText);

int GetTipText(int iField, [Runtime::InteropServices::Out] std::wstring const & & pbstrTipText);

public int GetTipText (int iField, out string pbstrTipText);

abstract member GetTipText : int * string -> int

Public Function GetTipText (iField As Integer, ByRef pbstrTipText As String) As Integer

Parameters

iField

Int32

[in] An integer value representing the field column to use for the Tip Text.

pbstrTipText

String

[out] A pointer to a string containing the Tip Text.

Returns

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  
);