IVsFormatFilterProvider.GetFormatFilterList Method

Provides the list of available extensions for the Save As dialog.

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

Syntax

'Declaration
Function GetFormatFilterList ( _
    <OutAttribute> ByRef pbstrFilterList As String _
) As Integer
int GetFormatFilterList(
    out string pbstrFilterList
)
int GetFormatFilterList(
    [OutAttribute] String^% pbstrFilterList
)
abstract GetFormatFilterList : 
        pbstrFilterList:string byref -> int
function GetFormatFilterList(
    pbstrFilterList : String
) : int

Parameters

  • pbstrFilterList
    Type: System.String%

    [out] The list of available extensions.

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 textmgr.idl:

HRESULT IVsFormatFilterProvider::GetFormatFilterList(
   [out] BSTR *pbstrFilterList
);

If no filter is provided, the default filter string is "All Files (*.*)\n*.*\nText Files (*.txt)\n*.txt\n" This filter list should not contain the All Files filer or Text Files. These will be added by the environment.

.NET Framework Security

See Also

Reference

IVsFormatFilterProvider Interface

Microsoft.VisualStudio.TextManager.Interop Namespace