Sign in Join
FPDoc Onlineexperiment

LoadCollation function

In unit unicodedata

Load a binary collation data file from file.

Declaration

pascal
function LoadCollation(const AData: Pointer; 
 const ADataLength: Integer; 
 var AAliases: TUnicodeStringArray): PUCA_DataBook
 ; overload

Arguments

AData

Memory area containing encoded collation data.

ADataLength

Length of memory area AData.

AAliases

Function result

Pointer to prepared collation data.

Description

LoadCollation loads collation data from file AFileName, or from a memory block AData with length ADataLength. If successful, it returns a pointer which can be used to register the collation using RegisterCollation. if there is a problem with the data, Nil is returned.

The filename can also be specified as a Directory and language name ALanguage. The latter is prepended with collation_ and appended with the native endianness of the current platform, and has extension .bco

Errors

If the file containing data does not exist or has a size which is less than the encoded header size, Nil is returned.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.