CompletionSet::CompareItems Method (String^, String^, Int32, Int32)

 

Compares two strings for the specified number of characters.

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

public:
virtual int CompareItems(
	String^ bstrSoFar,
	String^ bstrOther,
	int lCharactersToCompare,
	[OutAttribute] int% plResult
)

Parameters

bstrSoFar
Type: System::String^

The first string to compare.

bstrOther
Type: System::String^

The second string to compare.

lCharactersToCompare
Type: System::Int32

The number of characters to compare.

plResult
Type: System::Int32

[out] The result of the comparison.

Return Value

Type: System::Int32

If the method is successful, returns S_OK; otherwise, returns an error code (in which case the default comparison is used).

The plResult should be returned as follows: if bstrSoFar comes before bstrOther, plResult < 0. If bstrSoFar is equivalent to bstrOther, plResult is 0. If bstrSoFar comes after bstrOther, plResult > 0.

This method is the implementation of the CompareItems method of the IVsCompletionSetEx interface.

By default this method is not implemented and returns plResult as 0 and F:Microsoft.VisualStudio.NativeMethods.E_NOTIMPL.

Return to top
Show: