IVsFormatFilterProvider.GetFormatFilterList(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

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

public:
 int GetFormatFilterList([Runtime::InteropServices::Out] System::String ^ % pbstrFilterList);

int GetFormatFilterList([Runtime::InteropServices::Out] std::wstring const & & pbstrFilterList);

public int GetFormatFilterList (out string pbstrFilterList);

abstract member GetFormatFilterList : string -> int

Public Function GetFormatFilterList (ByRef pbstrFilterList As String) As Integer

Parameters

pbstrFilterList: String

[out] The list of available extensions.

Returns

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.

Applies to