Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IS_SURROGATE_PAIR macro (winnls.h)

Determines if the specified code units form a UTF-16 surrogate pair.

Syntax

bool IS_SURROGATE_PAIR(
 WCHAR hs,
 WCHAR ls
);

Parameters

hs

UTF-16 code unit to test for a high surrogate value. The range for a high UTF-16 code unit is 0xd800 to 0xdbff, inclusive.

ls

UTF-16 code unit to test for a low surrogate value. The range for a low UTF-16 code unit is 0xdc00 to 0xdfff, inclusive.

Return value

Type: bool

Returns TRUE if successful or FALSE otherwise.

Remarks

For this macro to succeed, the hs value must be a high UTF-16 code unit, and the ls value must be a low UTF-16 code unit.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winnls.h (include Windows.h)

See also

IS_HIGH_SURROGATE

IS_LOW_SURROGATE

National Language Support

National Language Support Macros

Surrogates and Supplementary Characters


Feedback

Was this page helpful?

Additional resources