IVsFilterAddProjectItemDlg.FilterListItemByTemplateFile Method

Article
04/29/2015

Filters files by actual template file name.

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

Syntax

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

int FilterListItemByTemplateFile(
    ref Guid rguidProjectItemTemplates,
    string pszTemplateFile,
    out int pfFilter
)

int FilterListItemByTemplateFile(
    [InAttribute] Guid% rguidProjectItemTemplates, 
    [InAttribute] String^ pszTemplateFile, 
    [OutAttribute] int% pfFilter
)

abstract FilterListItemByTemplateFile : 
        rguidProjectItemTemplates:Guid byref * 
        pszTemplateFile:string * 
        pfFilter:int byref -> int

function FilterListItemByTemplateFile(
    rguidProjectItemTemplates : Guid, 
    pszTemplateFile : String, 
    pfFilter : int
) : int

Parameters

rguidProjectItemTemplates
Type: Guid%

[in] GUID of the project supplying the item templates.

pszTemplateFile
Type: String

[in] Pointer to a null terminated string containing the template file name.

pfFilter
Type: Int32%

[out] Set to true to filter out the specified item. Set to false to display the item.

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 IVsFilterAddProjectItemDlg::FilterListItemByTemplateFile(
   [in] REFGUID rguidProjectItemTemplates,
   [in] LPCOLESTR pszTemplateFile,
   [out] BOOL *pfFilter
);

The environment passes in a project GUID and an item name. Return false to display the item and true to filter the item.

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

Partager via