DosQueryCollate - Parameters

cb (ULONG) - input

The length, in bytes, of the data area (pch) provided by the caller.

A length value of 256 bytes is sufficient.

pcc (PCOUNTRYCODE) - input

Pointer to the COUNTRYCODE structure in which the country code and code page are identified.

If country is set to 0, the collate table for the default system country code is returned.

If codepage is set to 0, the collate table for the current process code page of the caller is returned.

Refer to the COUNTRYCODE for a table of values for country code and code page identifier.

pch (PCHAR) - output

The data area where the collating sequence table is returned.

The caller provides this data area. The input parameter cb specifies the length of this area.

If this area is too small to hold all of the available information, then as much information as possible is provided in the available space (in the order in which the data would appear). If the amount of data returned is not enough to fill the memory area provided by the caller, then the memory that is unaltered by the available data is zeroed out. The format of the information returned in this buffer is as follows:

• Byte
  Sort weight of ASCII (0)
  1 Byte
  Sort weight of ASCII (1)
  ...
  (additional values in collating order)
  1 Byte
  Sort weight of ASCII (255)

  pcch (PULONG) - output

  The length, in bytes, of the collating sequence table returned.

  ulrc (APIRET) - returns

  Return Code.

  DosQueryCollate returns one of the following values:

  • NO_ERROR 397
    ERROR_NLS_OPEN_FAILED
    398
    ERROR_NLS_NO_CTRY_CODE
    399
    ERROR_NLS_TABLE_TRUNCATED
    401
    ERROR_NLS_TYPE_NOT_FOUND
    476
    ERROR_CODE_PAGE_NOT_FOUND
    For a full list of error codes, see Errors.

  ---

  [Back: DosQueryCollate Return Value - ulrc]
  [Next: DosQueryCollate - Remarks]