IVsTaskProvider2.SubcategoryList Method

Article
03/06/2013

Returns the list of subcategories for the tasks of this task provider.

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

Syntax

'Declaration
Function SubcategoryList ( _
    cbstr As UInteger, _
    <OutAttribute> rgbstr As String(), _
    <OutAttribute> ByRef pcActual As UInteger _
) As Integer

int SubcategoryList(
    uint cbstr,
    string[] rgbstr,
    out uint pcActual
)

int SubcategoryList(
    [InAttribute] unsigned int cbstr, 
    [OutAttribute] array<String^>^ rgbstr, 
    [OutAttribute] unsigned int% pcActual
)

abstract SubcategoryList : 
        cbstr:uint32 * 
        rgbstr:string[] byref * 
        pcActual:uint32 byref -> int

function SubcategoryList(
    cbstr : uint, 
    rgbstr : String[], 
    pcActual : uint
) : int

Parameters

cbstr
Type: System.UInt32
[in] Number of subcategories in the list.

rgbstr
Type: array<System.String[]
[out, size_is(cbstr)] Array of BSTRs whose elements represent the subcategories indicated by cbstr.

pcActual
Type: System.UInt32%
[out] Pointer to the number of BSTRs contained in the rgbstrarray.

Return Value

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

Implements

IVsTaskProvider.SubcategoryList(UInt32, array<String[], UInt32%)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsTaskProvider2::SubcategoryList(
   [in] ULONG cbstr,
   [out, size_is(cbstr)] BSTR rgbstr[],
   [out] ULONG *pcActual
);

A subcategory is a string expressing an appropriate subdivision for the tasks you are providing. For example, an error from a FORTRAN compiler might have a category of CAT_BUILDCOMPILE and subcategories of FORTRAN ERROR and FORTRAN WARNING. The subcategories are never shown to the user, but are used in sorting.

The task provider returns the list of subcategories for the tasks that it provides, and each task item it provides returns an index into the subcategory list.

The rgbstr parameter returns a null terminated array of BSTRs. The task list caches this information, and frees both the BSTRs and the array when it is done with the list.

If cbstr is passed in as zero and rgbstr as nulla null reference (Nothing in Visual Basic), then the provider should set *pcActual to the number of BSTRs that must be returned.

.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