IVsTaskItem2.get_CustomColumnText Method

Article
04/29/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

'Declaration
Function get_CustomColumnText ( _
    ByRef guidView As Guid, _
    iCustomColumnIndex As UInteger, _
    <OutAttribute> ByRef pbstrText As String _
) As Integer

int get_CustomColumnText(
    ref Guid guidView,
    uint iCustomColumnIndex,
    out string pbstrText
)

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

abstract get_CustomColumnText : 
        guidView:Guid byref * 
        iCustomColumnIndex:uint32 * 
        pbstrText:string byref -> int

function get_CustomColumnText(
    guidView : Guid, 
    iCustomColumnIndex : uint, 
    pbstrText : String
) : int

Parameters

guidView
Type: Guid%

[in] GUID of the task list view.

iCustomColumnIndex
Type: UInt32

[in] Index of the customized field.

pbstrText
Type: String%

[out] Pointer to a string containing the customized field text.

Return Value

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

Remarks

COM Signature

From vsshell.idl:

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.

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

Share via