en:docs:fapi:doscasemap

Differences

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

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:doscasemap [2018/08/31 01:51] – created prokusheven:docs:fapi:doscasemap [2021/09/17 09:22] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== DosCaseMap ======
  
 This call performs case mapping on a string of binary values that represent ASCII characters. This call performs case mapping on a string of binary values that represent ASCII characters.
  
-==Syntax== +===== Syntax ===== 
- DosCaseMap (Length, Country, BinaryString)+<code c> 
 +DosCaseMap (Length, Country, BinaryString) 
 +</code>
  
-==Parameters== +===== 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: +  Length ([[USHORT]]) - input : Length of the string of binary values to be case mapped. 
-:country (USHORT) : Country code identifier is a binary value of the selected country code. 0 is the default country code.  +  Country ([[PCOUNTRYCODE]]) - input/output : Address of the country information structure: 
-:codepage (USHORT) : Code page identifier is a binary value of the selected code page. 0 is the code page of the current process. +    *country ([[USHORT]]) : Country code identifier is a binary value of the selected country code. 0 is the default country code.  
-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.+    *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== 
- rc (USHORT) - return 
 Return code descriptions are: 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==+  * 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. 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.
  
Line 34: Line 44:
 The returned country dependent information may be for the default country and current process code page or for a specific country and 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=== +===== Bindings ===== 
-<PRE>+ 
 +==== C Binding ===
 + 
 +<code c>
 typedef struct _COUNTRYCODE {   /* ctryc */ typedef struct _COUNTRYCODE {   /* ctryc */
    
Line 52: Line 65:
  
 USHORT           rc;            /* return code */ USHORT           rc;            /* return code */
-</PRE>+</code>
  
-===MASM Binding=== +==== MASM Binding ===
-<PRE>+ 
 +<code asm>
 COUNTRYCODE struc COUNTRYCODE struc
    
Line 70: Line 84:
 PUSH@  OTHER   BinaryString  ;Binary string PUSH@  OTHER   BinaryString  ;Binary string
 CALL   DosCaseMap CALL   DosCaseMap
 +
 +</code>
  
 Returns WORD Returns WORD
-</PRE> 
  
-==Example Code==+==== Example Code ==== 
 This example case maps a string for the default country and code page 850.  This example case maps a string for the default country and code page 850. 
-<PRE>+<code c>
 #define INCL_DOSNLS #define INCL_DOSNLS
  
Line 93: Line 109:
                    &Country,                  /* Input data structure */                    &Country,                  /* Input data structure */
                    BinString);                /* String */                    BinString);                /* String */
-</PRE> +</code>
- +
  
-====== Note ======+===== Note =====
  
 Text based on [[http://www.edm2.com/index.php/DosCaseMap_(FAPI)]] Text based on [[http://www.edm2.com/index.php/DosCaseMap_(FAPI)]]