IsTextUnicode function (winbase.h)

Determines if a buffer is likely to contain a form of Unicode text.

Syntax

BOOL IsTextUnicode(
  [in]                const VOID *lpv,
  [in]                int        iSize,
  [in, out, optional] LPINT      lpiResult
);

Parameters

[in] lpv

Pointer to the input buffer to examine.

[in] iSize

Size, in bytes, of the input buffer indicated by lpv.

[in, out, optional] lpiResult

On input, pointer to the tests to apply to the input buffer text. On output, this parameter receives the results of the specified tests: 1 if the contents of the buffer pass a test, 0 for failure. Only flags that are set upon input to the function are significant upon output.

If lpiResult is NULL, the function uses all available tests to determine if the data in the buffer is likely to be Unicode text.

This parameter can be one or more of the following values. Values can be combined with binary "OR".

Return value

Returns a nonzero value if the data in the buffer passes the specified tests. The function returns 0 if the data in the buffer does not pass the specified tests.

Remarks

This function uses various statistical and deterministic methods to make its determination, under the control of flags passed in the lpiResult parameter. When the function returns, the results of such tests are reported using the same parameter.

The IS_TEXT_UNICODE_STATISTICS and IS_TEXT_UNICODE_REVERSE_STATISTICS tests use statistical analysis. These tests are not foolproof. The statistical tests assume certain amounts of variation between low and high bytes in a string, and some ASCII strings can slip through. For example, if lpv indicates the ASCII string 0x41, 0x0A, 0x0D, 0x1D (A\n\r^Z), the string passes the IS_TEXT_UNICODE_STATISTICS test, although failure would be preferable.

Requirements

See also

Unicode and Character Set Functions

Unicode and Character Sets