#include "unicode/utypes.h"
Go to the source code of this file.
Compounds | |
struct | UDataInfo |
UDataInfo contains the properties about the requested data. More... | |
Typedefs | |
typedef UDataMemory | UDataMemory |
Forward declaration of the data memory type. More... | |
typedef UBool U_CALLCONV | UDataMemoryIsAcceptable (void *context, const char *type, const char *name, const UDataInfo *pInfo) |
Callback function for udata_openChoice(). More... | |
Functions | |
UDataMemory * | udata_open (const char *path, const char *type, const char *name, UErrorCode *pErrorCode) |
Convenience function. More... | |
UDataMemory * | udata_openChoice (const char *path, const char *type, const char *name, UDataMemoryIsAcceptable *isAcceptable, void *context, UErrorCode *pErrorCode) |
Data loading function. More... | |
void | udata_close (UDataMemory *pData) |
Close the data memory. More... | |
const void * | udata_getMemory (UDataMemory *pData) |
Get the pointer to the actual data inside the data memory. More... | |
void | udata_getInfo (UDataMemory *pData, UDataInfo *pInfo) |
Get the information from the data memory header. More... | |
void | udata_setCommonData (const void *data, UErrorCode *err) |
This function bypasses the normal ICU data loading process and allows you to force ICU's system data to come out of a user-specified area in memory. More... | |
void | udata_setAppData (const char *packageName, const void *data, UErrorCode *err) |
This function bypasses the normal ICU data loading process for application-specific data and allows you to force the it to come out of a user-specified pointer. More... |
This API is used to find and efficiently load data for ICU and applications using ICU. It provides an abstract interface that specifies a data type and name to find and load the data. Normally this API is used by other ICU APIs to load required data out of the ICU data library, but it can be used to load data out of other places.
See the User Guide Data Management chapter.
Definition in file udata.h.
|
Forward declaration of the data memory type.
|
|
Callback function for udata_openChoice().
|
|
Close the data memory. This function must be called to allow the system to release resources associated with this data memory.
|
|
Get the information from the data memory header.
This allows to get access to the header containing platform data properties etc. which is not part of the data itself and can therefore not be accessed via the pointer that
*pInfo will be filled with the UDataInfo structure in the data memory object. If this structure is smaller than pInfo->size , then the size will be adjusted and only part of the structure will be filled.
|
|
Get the pointer to the actual data inside the data memory. The data is read-only.
|
|
Convenience function.
This function works the same as
|
|
Data loading function. This function is used to find and load efficiently data for ICU and applications using ICU. It provides an abstract interface that allows to specify a data type and name to find and load the data.
The implementation depends on platform properties and user preferences and may involve loading shared libraries (DLLs), mapping files into memory, or fopen()/fread() files. It may also involve using static memory or database queries etc. Several or all data items may be combined into one entity (DLL, memory-mappable file).
The data is always preceded by a header that includes a
If
For details about ICU data loading see the User Guide Data Management chapter. (http://oss.software.ibm.com/icu/userguide/icudata.html)
|
|
This function bypasses the normal ICU data loading process for application-specific data and allows you to force the it to come out of a user-specified pointer. The format of this data is that of the icu common data file, like 'icudt26l.dat' or the corresponding shared library (DLL) file. The application must read in or otherwise construct an image of the data and then pass the address of it to this function. Warning: setAppData will set a U_USING_DEFAULT_WARNING code if data with the specifed path that has already been opened, or if setAppData with the same path has already been called. Any such calls to setAppData will have no effect.
|
|
This function bypasses the normal ICU data loading process and allows you to force ICU's system data to come out of a user-specified area in memory. The format of this data is that of the icu common data file, as is generated by the pkgdata tool with mode=common or mode=dll. You can read in a whole common mode file and pass the address to the start of the data, or (with the appropriate link options) pass in the pointer to the data that has been loaded from a dll by the operating system, as shown in this code: extern const char U_IMPORT U_ICUDATA_ENTRY_POINT []; // U_ICUDATA_ENTRY_POINT is same as entry point specified to pkgdata tool UErrorCode status = U_ZERO_ERROR; udata_setCommonData(&U_ICUDATA_ENTRY_POINT, &status); Warning: ICU must NOT have even attempted to access its data yet when this call is made, or U_USING_DEFAULT_WARNING code will be returned. Be careful of UnicodeStrings in static initialization which may attempt to load a converter (use the UNICODE_STRING(x) macro instead). Also note that it is important that the declaration be as above. The entry point must not be declared as an extern void*. This function has no effect on application (non ICU) data. See udata_setAppData() for similar functionality for application data.
|