Locale context for the mapping. The strings are assumed to be represented in
the default ANSI code page for this locale.
Flags that indicate what type of transformation is to occur during mapping.
Several flags can be combined on a single transformation (though some
combinations are illegal). Mapping options include the following.
||Character sort key.
||Narrow characters (where applicable).
||Wide characters (where applicable).
||Ignore case; default is OFF.
||Ignore nonspacing; default is OFF.
||Ignore character width; default is OFF.
||Ignore Japanese hiragana/katakana character differences; default is OFF.
||Ignore symbols; default is OFF.
The latter five options (NORM_IGNORECASE, NORM_IGNORENONSPACE,
NORM_IGNOREWIDTH, NORM_IGNOREKANATYPE,and NORM_IGNORESYMBOLS) are normalization options that
can only be used in combination with the LCMAP_SORTKEY conversion option.
Conversion options can be combined only when they are taken from the following
three groups, and then only when there is no more than one option from each
- Casing options (LCMAP_LOWERCASE, LCMAP_UPPERCASE)
- Width options (LCMAP_HALFWIDTH, LCMAP_FULLWIDTH)
- Kana options (LCMAP_HIRAGANA, LCMAP_KATAKANA)
Pointer to the supplied string to be mapped.
Character count of the input string buffer. If
is assumed to be null-terminated and the length will be calculated
Pointer to the memory buffer to store the resulting mapped string.
Character count of the memory buffer pointed to by lpDestStr
. If cchDest
is 0, then the return value of this function is the number of characters
required to hold the mapped string. The lpDestStr
pointer is not referenced in this case.
|The number of characters written to lpDestSt
LCMapStringA maps one character string to another, performing the specified
The flag LCMAP_UPPER produces the same result as AnsiUpper
in the given locale; the flag LCMAP_LOWER produces the same result as AnsiLower
. In particular, like these functions, this function always maps a single
character to a single character.
The mapped string will be null-terminated if the source string is
When used with LCMAP_UPPER and LCMAP_LOWER, the lpSrcStr
may be the same to produce an in-place mapping. When LCMAP_SORTKEY is used,
pointers may not
be the same; an error will result in this case.
The LCMAP_SORTKEY transformation transforms two strings such that when
compared with the standard C library function strcmp
(by strict numerical valuation of their characters), the same order would
result as if the original strings were compared with CompareStringA
. When LCMAP_SORTKEY is specified, the output string will be a string (without
NULLs, except for the terminator), but the "character" values will not be
meaningful display values. This is similar behavior to the ANSI C function strxfrm
- Software for developers
Software for Android Developers
- More information resources
Unix Manual Pages