en:docs:fapi:doscasemap
no way to compare when less than two revisions

Differences

This shows you the differences between two versions of the page.


Previous revision
Next revision
—en:docs:fapi:doscasemap [2020/12/04 13:03] – prokushev
Line 1: Line 1:
 +{{logos:os2.gif?35x35}} {{logos:dos.gif?35x35}}
 +
 +====== DosCaseMap ======
 +
 +This call performs case mapping on a string of binary values that represent ASCII characters.
 +
 +==Syntax==
 + DosCaseMap (Length, Country, BinaryString)
 +
 +==Parameters==
 +;Length (USHORT) - input : Length of the string of binary values to be case mapped.
 +;Country (PCOUNTRYCODE) - input/output : Address of the country information structure:
 +:country (USHORT) : Country code identifier is a binary value of the selected country code. 0 is the default country code. 
 +:codepage (USHORT) : Code page identifier is a binary value of the selected code page. 0 is the code page of the current process.
 +; BinaryString (PCHAR) - input/output : Address of a string of binary characters to be case mapped. They are case mapped in place so the results appear in BinaryString and the input is destroyed.
 +
 +==Return Code==
 + rc (USHORT) - return
 +Return code descriptions are:
 +* 0          NO_ERROR 
 +* 396        ERROR_NLS_NO_COUNTRY_FILE 
 +* 397        ERROR_NLS_OPEN_FAILED 
 +* 398        ERROR_NO_COUNTRY_OR_CODEPAGE 
 +* 399        ERROR_NLS_TABLE_TRUNCATED
 +
 +==Remarks==
 +DosCaseMap is mainly used to map a lower case character string to an upper case character string. Unless the user replaces the country information file, DosCaseMap only does the conversion from lower case to upper case.
 +
 +The case map information is taken from the country information file. See the COUNTRY statement in the ''IBM Operating System/2 Version 1.2 Command Reference'' for information on how to specify the country information file.
 +
 +If countrycode is 0, the case mapping is performed using the information for the country specified in the COUNTRY statement in CONFIG.SYS.
 +
 +If countrycode is not 0, the case mapping is performed using the information for that country.
 +
 +If the code page identifier is 0, the case mapping is performed using the information for the current process code page. Refer to [[DosSetCp]] and the CHCP command in the ''IBM Operating System/2 Version 1.2 Command Reference'' for information on setting the process code page. If codepage is not 0, the case mapping is performed using the information for that code page.
 +
 +The returned country dependent information may be for the default country and current process code page or for a specific country and code page. 
 +
 +===C Binding===
 +<PRE>
 +typedef struct _COUNTRYCODE {   /* ctryc */
 + 
 +  USHORT country;               /* country code */
 +  USHORT codepage;              /* code page */
 + 
 +} COUNTRYCODE;
 +
 +#define INCL_DOSNLS
 +
 +USHORT  rc = DosCaseMap(Length, Structure, BinaryString);
 +
 +USHORT           Length;        /* Length of string to case map */
 +PCOUNTRYCODE     Structure;     /* Input data structure */
 +PCHAR            BinaryString;  /* Address of binary string */
 +
 +USHORT           rc;            /* return code */
 +</PRE>
 +
 +===MASM Binding===
 +<PRE>
 +COUNTRYCODE struc
 + 
 +  ctryc_country   dw  ? ;country code
 +  ctryc_codepage  dw  ? ;code page
 + 
 +COUNTRYCODE ends
 +
 +EXTRN  DosCaseMap:FAR
 +INCL_DOSNLS         EQU 1
 +
 +PUSH   WORD    Length        ;Length of string to case map
 +PUSH@  OTHER   Structure     ;Input data structure
 +PUSH@  OTHER   BinaryString  ;Binary string
 +CALL   DosCaseMap
 +
 +Returns WORD
 +</PRE>
 +
 +==Example Code==
 +This example case maps a string for the default country and code page 850. 
 +<PRE>
 +#define INCL_DOSNLS
 +
 +#define CURRENT_COUNTRY 0
 +#define NLS_CODEPAGE 850
 +
 +COUNTRYCODE Country;
 +CHAR        BinString[30];
 +USHORT      rc;
 +
 +
 +   Country.country = CURRENT_COUNTRY;         /* Country code */
 +   Country.codepage = NLS_CODEPAGE;           /* Code page */
 +   strcpy(BinString,"Howdy");                 /* String to map */
 +   rc = DosCaseMap(sizeof(BinString),         /* Length of string */
 +                   &Country,                  /* Input data structure */
 +                   BinString);                /* String */
 +</PRE>
 +
 +
 +
 +====== Note ======
 +
 +Text based on [[http://www.edm2.com/index.php/DosCaseMap_(FAPI)]]
 +
 +{{page>en:templates:fapi}}