Home   Index   About
Ultimate Pack


Custom Search
LCMapStringA

(LCID, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest)
LCID LCID
DWORD dwMapFlags
LPCSTR lpSrcStr
int cchSrc
LPSTR lpDestStr
int cchDest

Parameters

LCID

Locale context for the mapping. The strings are assumed to be represented in the default ANSI code page for this locale.

dwMapFlags

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.

Name
Meaning
LCMAP_LOWERCASE
Lowercase.
LCMAP_UPPERCASE
Uppercase.
LCMAP_SORTKEY
Character sort key.
LCMAP_HALFWIDTH
Narrow characters (where applicable).
LCMAP_FULLWIDTH
Wide characters (where applicable).
LCMAP_HIRAGANA
Hiragana.
LCMAP_KATAKANA
Katakana.
NORM_IGNORECASE
Ignore case; default is OFF.
NORM_IGNORENONSPACE
Ignore nonspacing; default is OFF.
NORM_IGNOREWIDTH
Ignore character width; default is OFF.
NORM_IGNOREKANATYPE
Ignore Japanese hiragana/katakana character differences; default is OFF.
NORM_IGNORESYMBOLS
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 group:

  • Casing options (LCMAP_LOWERCASE, LCMAP_UPPERCASE)

  • Width options (LCMAP_HALFWIDTH, LCMAP_FULLWIDTH)

  • Kana options (LCMAP_HIRAGANA, LCMAP_KATAKANA)

lpSrcStr

Pointer to the supplied string to be mapped.

cchSrc

Character count of the input string buffer. If pics/OLE00090001.gif1, lpSrcStr is assumed to be null-terminated and the length will be calculated automatically.

lpDestStr

Pointer to the memory buffer to store the resulting mapped string.

cchDest

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.

Return Value

Value
Meaning
0
Failure
The number of characters written to lpDestSt
Success

Comments

LCMapStringA
maps one character string to another, performing the specified locale-dependent translation.

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 null-terminated.

When used with LCMAP_UPPER and LCMAP_LOWER, the lpSrcStr and lpDestStr may be the same to produce an in-place mapping. When LCMAP_SORTKEY is used, the lpSrcStr and lpDestStr 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.


Last news from Greatis Software

Nostalgia .Net     Nostalgia .Net     .Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes.  More »

Recommended software for developers

Ultimate Pack for Delphi and C++ Builder     Ultimate Pack     Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price.  More »

Form Designer .Net     Form Designer .Net     Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro!  More »

Print Suite .Net     Print Suite .Net     Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available  More »

Gradient Controls .Net     Gradient Controls .Net     Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available  More »

iGrid     Greatis iGrid     iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors.  More »


All the contacts and projects

Dmitry Vasiliev (just.dmitry)

Related Links

Software for Visual Studio .NET developers
Software for Delphi and C++ Builder developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET

More Online Helps

Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages

Free Tech Secrets ;) Copyright © 2008-2012 Free Tech Secrets ;) greatis just4fun network just4fun