LanguageService.IVsFormatFilterProvider.QueryInvalidEncoding Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

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.

Determines if the specified source format is valid or not.

 virtual int Microsoft.VisualStudio.TextManager.Interop.IVsFormatFilterProvider.QueryInvalidEncoding(System::UInt32 format, [Runtime::InteropServices::Out] System::String ^ % pbstrMessage) = Microsoft::VisualStudio::TextManager::Interop::IVsFormatFilterProvider::QueryInvalidEncoding;

int Microsoft.VisualStudio.TextManager.Interop.IVsFormatFilterProvider.QueryInvalidEncoding(unsigned int format, [Runtime::InteropServices::Out] std::wstring const & & pbstrMessage);

int IVsFormatFilterProvider.QueryInvalidEncoding (uint format, out string pbstrMessage);

abstract member Microsoft.VisualStudio.TextManager.Interop.IVsFormatFilterProvider.QueryInvalidEncoding : uint32 * string -> int
override this.Microsoft.VisualStudio.TextManager.Interop.IVsFormatFilterProvider.QueryInvalidEncoding : uint32 * string -> int

Function QueryInvalidEncoding (format As UInteger, ByRef pbstrMessage As String) As Integer Implements IVsFormatFilterProvider.QueryInvalidEncoding

Parameters

format: UInt32

[in] The format to test. This is a value from __VSTFF enumeration.

pbstrMessage: String

[out] An error string describing why or how the format is invalid. Could be as simple as "The XX format is not supported."

Returns

Int32

If the format is not supported, returns S_OK; otherwise, return S_FALSE (the format is supported).

Implements

QueryInvalidEncoding(UInt32, String)

Remarks

The base method calls the other Microsoft.VisualStudio.Package.LanguageService.QueryInvalidEncoding and converting the return values of true and false to S_OK and S_FALSE, respectively.

Applies to