CharLowerWrapW function

[CharLowerWrapW is available for use in Windows XP. It may not be available in subsequent versions. You should use CharLowerW in its place.]

Converts a Unicode character string or a single character to lowercase. If the operand is a character string, the function converts the characters in place.

Note

CharLowerWrapW is a wrapper for the CharLowerW function. See the CharLower page for further usage notes.

 

Syntax

LPWSTR CharLowerWrapW(
  _Inout_ LPWSTR pch
);

Parameters

pch [in, out]

Type: LPWSTR

A pointer to a null-terminated Unicode string or a single character. If the high-order word of this parameter is zero, the low-order word must contain only a single character to be converted.

Return value

Type: LPWSTR

If pch is a character string, the function returns a pointer to the converted string. Since the string is converted in place, the return value is equal to pch.

If pch is a single character, the return value is a 32-bit value whose high-order word is zero, and low-order word contains the converted character.

There is no indication of success or failure. Failure is rare. There is no extended error information for this function; do not call GetLastError.

Remarks

The preferred method is to use CharLowerW in conjunction with the Microsoft Layer for Unicode (MSLU).

CharLowerWrapW must be called directly from Shlwapi.dll, using ordinal 38.

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
DLL
Shlwapi.dll (version 5.0 or later)

See also

CharLower