dos12.hlp (Table of Contents; Topic list)
Important Notice
The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.
DosCaseMap (1.2)
Function Group                                      Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSNLS
 
USHORT DosCaseMap(cch, pctryc, pchString)
USHORT cch;             /* length of string to casemap           */
PCOUNTRYCODE pctryc;    /* pointer to structure for country code */
PCHAR pchString;        /* pointer to character string           */
 
The DosCaseMap function casemaps the characters in the given string. If
necessary, the function replaces characters in the string with the correct
case-mapped characters.
 
The DosCaseMap function uses the casemap information in the country.sys file
to casemap the string.
 
The DosCaseMap function is a family API function.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
cch        Specifies the length of the given string.
 
pctryc     Points to the COUNTRYCODE structure that contains the country
           code and the code-page identifier for the casemap operation.
 
pchString  Points to the character string to be casemapped.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be one of the following:
 
     ERROR_NLS_BAD_TYPE
     ERROR_NLS_NO_COUNTRY_FILE
     ERROR_NLS_NO_CTRY_CODE
     ERROR_NLS_OPEN_FAILED
     ERROR_NLS_TABLE_TRUNCATED
     ERROR_NLS_TYPE_NOT_FOUND
 
Restrictions
 
In real mode, the following restriction applies to the DosCaseMap function:
 
♦  There is no method of identifying the boot drive. The system assumes that
   the country.sys file is in the root directory of the current drive.
 
See Also
 
DosGetCollate, DosGetCtryInfo, DosSetCp, COUNTRYCODE