[Toc][Index]

DosGetCollate


Bindings:  C, MASM 

This call obtains a collating sequence table (for characters hex 00H 
through FFH) that resides in the country information file.  It is used by 
the SORT utility to sort text according to the collating sequence. 
 DosGetCollate    (Length, Country, MemoryBuffer, DataLength) 
 
 Length (USHORT) - input 
    Length, in bytes, of the data area (MemoryBuffer). A length value of 
    256 is sufficient. 
 Country (PCOUNTRYCODE) - input 
    Address of the country information structure: 
    country (USHORT) 
       Country code identifier. 0 is the default country code. 
    codepage (USHORT) 
       Code page identifier. 0 is the code page of the current process. 
 MemoryBuffer (PCHAR) - output 
    Address of the collating table. This memory area is provided by the 
    caller. The size of the area is provided by the input parameter 
    Length.  If it is too small to hold all the available information then 
    as much information as possible is provided in the available space (in 
    the order that the data would appear).  If the amount of returned data 
    does not fill the memory area provided by the caller, the unaltered 
    memory is set at 0. The buffer format for the returned information is: 
    
    Byte      Description 
    0         Sort weight of ASCII (0) 
    1         Sort weight of ASCII (1) 
    .           
    .           
    .           
    255       Sort weight of ASCII (255) 
 DataLength (PUSHORT) - output 
    Address of the length, in bytes, of the collate table. 
 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 
 The returned country-dependent information can be for the default country 
 and current process code page or for a specific country and code page. 
 For more information see DosSetCp. 

Created using Inf-PHP v.2 (c) 2003 Yuri Prokushev
Created using Inf-HTML v.0.9b (c) 1995 Peter Childs