IVsTaskProvider.SubcategoryList(UInt32, String[], UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int SubcategoryList(System::UInt32 cbstr, cli::array <System::String ^> ^ rgbstr, [Runtime::InteropServices::Out] System::UInt32 % pcActual);

int SubcategoryList(unsigned int cbstr, std::Array <std::wstring const &> const & rgbstr, [Runtime::InteropServices::Out] unsigned int & pcActual);

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

abstract member SubcategoryList : uint32 * string[] * uint32 -> int

Public Function SubcategoryList (cbstr As UInteger, rgbstr As String(), ByRef pcActual As UInteger) As Integer

Parameters

cbstr: UInt32

in] Number of subcategories in the list.

rgbstr: String[]

[out, size_is(cbstr)] Array of BSTRs whose elements represent the subcategories indicated by cbstr.

pcActual: UInt32

[out] Pointer to the number of BSTRs contained in the rgbstrarray.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsTaskProvider::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 null, then the provider should set *pcActual to the number of BSTRs that must be returned.

Applies to

共用方式為