please dont rip this site Prev Next

FoldString info  Overview  Group

The FoldString function maps one string to another, performing a specified transformation option.

int FoldString(

    DWORD dwMapFlags,

// mapping transformation options

    LPCTSTR lpSrcStr,

// pointer to source string

    int cchSrc,

// size of source string, in bytes or characters

    LPTSTR lpDestStr,

// pointer to destination buffer

    int cchDest 

// size of destination buffer, in bytes or characters



A set of bit flags that indicate the type of transformation to be used during mapping. This value can be a combination of the following bit-flag constants:




Fold compatibility zone characters into standard Unicode equivalents. For information about compatibility zone characters, see the following Remarks section.


Map all digits to Unicode characters 0 through 9.


Map accented characters to precomposed characters, in which the accent and base character are combined into a single character value. This value cannot be combined with MAP_COMPOSITE.


Map accented characters to composite characters, in which the accent and base character are represented by two character values. This value cannot be combined with MAP_PRECOMPOSED.


Expand all ligature characters so that they are represented by their two-character equivalent. For example, the ligature '' expands to the two characters 'a' and 'e'. This value cannot be combined with MAP_PRECOMPOSED or MAP_COMPOSITE.

Points to the string to be mapped.
Specifies the size, in bytes (ANSI version) or characters (Unicode version), of the lpSrcStr buffer. If cchSrc is -1, lpSrcStr is assumed to be null-terminated, and the length is calculated automatically.
Points to the buffer to store the mapped string.
Specifies the size, in bytes (ANSI version) or characters (Unicode version), of the lpDestStr buffer. If cchDest is zero, the function returns the number of bytes or characters required to hold the mapped string, and the buffer pointed to by lpDestStr is not used.

Return Values

If the function succeeds, the return value is the number of bytes (ANSI version) or characters (Unicode version) written to the destination buffer, or if the cchDest parameter is zero, the number of bytes or characters required to hold the mapped string.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError may return one of the following error codes:



The mapped string is null-terminated if the source string is null-terminated.

The lpSrcStr and lpDestStr pointers must not be the same. If they are the same, the function fails and GetLastError returns ERROR_INVALID_PARAMETER.

The compatibility zone in Unicode consists of characters in the range 0xF900 through 0xFFEF that are assigned to characters from other character-encoding standards but are actually variants of characters that are already in Unicode. The compatibility zone is used to support round-trip mapping to these standards. Applications can use the MAP_FOLDCZONE flag to avoid supporting the duplication of characters in the compatibility zone.

See Also

LCMapString, CompareString

file: /Techref/os/win/api/win32/func/src/f25_11.htm, 6KB, , updated: 2000/4/7 12:19, local time: 2024/6/16 09:24,

 ©2024 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions?
Please DO link to this page! Digg it! / MAKE!

<A HREF=""> FoldString</A>

After you find an appropriate page, you are invited to your to this massmind site! (posts will be visible only to you before review) Just type a nice message (short messages are blocked as spam) in the box and press the Post button. (HTML welcomed, but not the <A tag: Instead, use the link box to link to another page. A tutorial is available Members can login to post directly, become page editors, and be credited for their posts.

Link? Put it here: 
if you want a response, please enter your email address: 
Attn spammers: All posts are reviewed before being made visible to anyone other than the poster.
Did you find what you needed?


Welcome to!


Welcome to!