LanguageService.IVsFormatFilterProvider.QueryInvalidEncoding(UInt32, String) Method

Definition

Determines if the specified source format is valid or not.

int IVsFormatFilterProvider.QueryInvalidEncoding (uint format, out string pbstrMessage);
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

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

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