LanguageService::IVsFormatFilterProvider::GetFormatFilterList Method (String^)

 

Returns a list of file extension filters suitable for a Save As dialog box.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

private:
virtual int GetFormatFilterList(
	[OutAttribute] String^% pbstrFilterList
) sealed = IVsFormatFilterProvider::GetFormatFilterList

Parameters

pbstrFilterList
Type: System::String^

[out] A string containing pairs of descriptions and extensions.

Return Value

Type: System::Int32

If successful, returns S_OK; otherwise, returns an error code.

This method supplies a list of file extension filters formatted for a Save As dialog box. The extensions are formatted in pairs of descriptions and extensions, with each element separated by newlines. For example, a set of filters for C++ and C# files might formatted as "C++ files (*.cpp)\n*.cpp\nC# files (*.c#)\n*.c#\n". Visual Studio always prepends the filter list "All Files (*.*)\n*.*\nText Files (*.txt)\n*.txt\n" to whatever is returned from this method.

The base method calls LanguageService::GetFormatFilterList and replaces all vertical bar characters ("|") with newlines. The base method also insures the returns filter list is terminated by a newline. This method is an implementation of IVsFormatFilterProvider::GetFormatFilterList.

Return to top
Show: