IVsTaskItem2::get_CustomColumnText Method (Guid, UInt32, String^)

Visual Studio 2015

Returns the text of a customized field for the specified task list view.

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

Syntax

C++

int get_CustomColumnText(
	[InAttribute] Guid% guidView,
	unsigned int iCustomColumnIndex,
	[OutAttribute] String^% pbstrText
)

Parameters

guidView: Type: System::Guid
[in] GUID of the task list view.

iCustomColumnIndex: Type: System::UInt32
[in] Index of the customized field.

pbstrText: Type: System::String^
[out] Pointer to a string containing the customized field 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 vsshell.idl:

C++

HRESULT IVsTaskItem2::get_CustomColumnText(
   [in]REFGUID guidView,
   [in]ULONG iCustomColumnIndex,
   [out, retval]BSTR *pbstrText
);

A task list view consists of a sort and a filter, and is determined solely by its GUID. See the AutoFilter2 for an example of how to implement a custom view.

A task item can have any number of customized fields, each specified by a different value of iCustomColumnIndex. A particular task list view might use any, all, or none of these customized fields. When a particular task list view is requested, the task list asks each task item if it supports the iCustomColumnIndex customized field for this guidView. If the task item does support this field, it should return the customized field text in pbstrText.

The VSTASKFIELD data type of a customized field has the value of FLD_CUSTOM.