IVsFilterAddProjectItemDlg2.FilterTreeItemByCategory Method

Article
2013-03-06

Filters tree elements by category.

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

Syntax

'Declaration
Function FilterTreeItemByCategory ( _
    ByRef rguidProjectItemTemplates As Guid, _
    pszCategoryName As String, _
    <OutAttribute> ByRef pfFilter As Integer _
) As Integer

int FilterTreeItemByCategory(
    ref Guid rguidProjectItemTemplates,
    string pszCategoryName,
    out int pfFilter
)

int FilterTreeItemByCategory(
    [InAttribute] Guid% rguidProjectItemTemplates, 
    [InAttribute] String^ pszCategoryName, 
    [OutAttribute] int% pfFilter
)

abstract FilterTreeItemByCategory : 
        rguidProjectItemTemplates:Guid byref * 
        pszCategoryName:string * 
        pfFilter:int byref -> int

function FilterTreeItemByCategory(
    rguidProjectItemTemplates : Guid, 
    pszCategoryName : String, 
    pfFilter : int
) : int

Parameters

rguidProjectItemTemplates
Type: System.Guid%
[in] GUID of the project supplying the item templates.

pszCategoryName
Type: System.String
[in] Pointer to a null terminated string containing the category template name.

pfFilter
Type: System.Int32%
[out] Set to true to filter out the specified item. Set to false to display the item.

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:

HRESULT IVsFilterAddProjectItemDlg2::FilterTreeItemByCategory(
   [in] REFGUID rguidProjectItemTemplates,
   [in] LPCOLESTR pszCategoryName,
   [out] BOOL *pfFilter
);

The environment passes in a project GUID and a category name. Return false to display items in the category and true to filter the category. You specify categories in your Template Directory Description (.Vsdir) Files.

.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