IVsTaskItem3::GetTipText Method (Int32, String^)

Visual Studio 2015

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

C++

int GetTipText(
	int iField,
	[OutAttribute] String^% pbstrTipText
)

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:

C++

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