Logo

maxdz Software GmbH

Eng | Ger
Home

Unser Team

B2B Produktekeyboard_arrow_down

mdz_ansikeyboard_arrow_down

Products

Downloads

Reference

Purchase

mdz_unicodekeyboard_arrow_down

mdz_vectorkeyboard_arrow_down

B2C Produkte

Gesetzliches

Kontakte

mdz_ansi API Reference is generated by mdzApiRefGenerator.

mdz_ansi API Reference

mdz_ansi Reference
mdz_ansi Reference
mdz_wchar Reference
mdz_utf8 Reference
mdz_utf16 Reference
mdz_utf32 Reference


Asynchronous execution

Many functions of mdz_ansi accept parameters for asynchronous execution.
The only relevant parameter is:

- struct mdz_asyncData* pAsyncData - pointer to shared async data for asynchronous call, or NULL if call should be synchronous

Fields of struct mdz_asyncData* are following:

TypeParameterDescription
void* m_pStringPointer to string instance
mdz_bool m_bFinishedmdz_true if the call is completely finished. Otherwise mdz_false (if interrupted/cancelled)
size_t m_nResultResult of call. Invalid if call is not completely finished (m_bFinished is mdz_false)
void* m_pDataAdditional data returned by call (if any). Invalid if call is not completely finished (m_bFinished is mdz_false)
mdz_bool m_bCancelShould be set by client in mdz_true during call execution, to cancel the call. Otherwise mdz_false
pthread_t / HANDLE m_hThreadHandle to thread on which the call is executed. May be used by client for wait operations


mdz_ansi Reference

mdz_ansi is dynamically-sized contiguous string, containing ASCII (0..127) and "ANSI" (128 - 255) characters.

Capacity - how many bytes of memory is reserved.
Size - how many characters are actually residing in a string, excluding terminating 0.

"reserve" functions allocate/reallocate memory dynamically using malloc()/realloc().
"attach" functionality allows attaching contiguous block of memory to string, for using string functions on it.

Library init functions:

mdz_ansi_init
mdz_ansi_init_attached
mdz_ansi_uninit

Init and destroy functions:

mdz_ansi_create
mdz_ansi_create_attached
mdz_ansi_destroy
mdz_ansi_clear
mdz_ansi_attachData

Reserve capacity functions:

mdz_ansi_reserve
mdz_ansi_reserveAndInit_async
mdz_ansi_capacity
mdz_ansi_size
mdz_ansi_resize
mdz_ansi_offsetFromStart
mdz_ansi_isAttachedData
mdz_ansi_embedSize

Insert/remove functions:

mdz_ansi_insert_async
mdz_ansi_removeFrom_async
mdz_ansi_remove_async
mdz_ansi_trimLeft_async
mdz_ansi_trimRight_async
mdz_ansi_trim_async

Find functions:

mdz_ansi_findSingle_async
mdz_ansi_find_async
mdz_ansi_firstOf_async
mdz_ansi_firstNotOf_async
mdz_ansi_rfindSingle_async
mdz_ansi_rfind_async
mdz_ansi_lastOf_async
mdz_ansi_lastNotOf_async

Miscellaneous functions:

mdz_ansi_compare_async
mdz_ansi_replace_async
mdz_ansi_count_async
mdz_ansi_copySubAnsi_async
mdz_ansi_copySubAnsiFrom_async


mdz_ansi_init

Initializes ansi library. This function should be caled before any other function of the library.

mdz_bool mdz_ansi_init(const uint32_t* pFirstNameHash, const uint32_t* pLastNameHash, const uint32_t* pEmailHash, const uint32_t* pLicenseHash);

ParameterDescription
pFirstNameHashuser first name hash code
pLastNameHashuser last name hash code
pEmailHashuser e-mail hash code
pLicenseHashlicense hash code

ReturnDescription
mdz_trueif the initialization has succeed, otherwise false

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_init_attached

Initializes ansi library. This function should be caled before any other function of the library.
Memory for license data starts at position pStart. Size of internal initialization structure is returned in pSize.

mdz_bool mdz_ansi_init_attached(const uint32_t* pFirstNameHash, const uint32_t* pLastNameHash, const uint32_t* pEmailHash, const uint32_t* pLicenseHash, const char* pStart, size_t nAreaSize, size_t* pOutSize);

ParameterDescription
pFirstNameHashuser first name hash code
pLastNameHashuser last name hash code
pEmailHashuser e-mail hash code
pLicenseHashlicense hash code
pStartmemory start position of license data
nAreaSizesize of available memory from pStart in bytes. Should be large enough for license data (> 500 bytes)
pOutSizeactual size of placed license data in bytes

ReturnDescription
mdz_trueif the initialization has succeed, otherwise false

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_uninit

Un-initializes ansi library and frees corresponding memory allocations.

void mdz_ansi_uninit(void);

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_create

Create empty string with Capacity and Size 0.

struct mdz_Ansi* mdz_ansi_create(size_t nEmbedSize);

ParameterDescription
nEmbedSizesize of "embedded part" of string. There is no "embedded part" if 0

ReturnDescription
NULLif library is not initialized with mdz_ansi_init() call
NULLif memory allocation failed
Resultpointer to string for use in other mdz_ansi functions

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_create_attached

Create empty string with Capacity and Size 0. Memory for mdz_Ansi structure starts at position pStart. Size of internal ansi structure (it is usually bigger than mdz_Ansi) is returned in pSize.

struct mdz_Ansi* mdz_ansi_create_attached(const void* pStart, size_t nAreaSizeBytes, size_t* pOutSize);

ParameterDescription
pStartmemory start position of mdz_Ansi structure
nAreaSizeBytessize of available memory from pStart in bytes. Should be large enough for internal Ansi structure
pOutSizereturned actual size of placed internal ansi structure in bytes, may be NULL if not needed

ReturnDescription
NULLif library is not initialized with mdz_ansi_init() call
NULLif pStart == NULL or pSize == NULL
NULLif size in nSize is smaller than size of internal ansi structure
Resultpointer to string for use in other mdz_Ansi functions. Normally it equals to pStart

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_destroy

Destroy string including underlying data. After destroying, pointer to string is set to NULL.
If string is attached using mdz_ansi_createAttached(), free() will not be called.
If string data is attached using mdz_ansi_attachData(), m_pData will not be destroyed.

void mdz_ansi_destroy(struct mdz_Ansi** ppAnsi);

ParameterDescription
ppAnsipointer to pointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_clear

Clear m_pData of string with setting Size in 0.

void mdz_ansi_clear(struct mdz_Ansi* pAnsi);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create()

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_attachData

Attach pre-allocated data to string, assigning pcData to m_pData. If attached, m_pData will not be destroyed in mdz_ansi_destroy()

mdz_bool mdz_ansi_attachData(struct mdz_Ansi* pAnsi, const char* pData, size_t nOffsetFromStart, size_t nCapacity, enum mdz_attach_type enAttachType);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
pDatapointer to pre-allocated data to attach
nOffsetFromStartposition in pre-allocated data to attach from. Can be > 0
nCapacityfull capacity pre-allocated data in items
enAttachTypetype of attachment. Only MDZ_ATTACH_ZEROSIZE and MDZ_ATTACH_SIZE_TERMINATOR are allowed

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_falseif pData == NULL (MDZ_ERROR_DATA), or nOffsetFromStart >= nCapacity (MDZ_ERROR_OFFSET), or invalid enAttachType (MDZ_ERROR_ATTACHTYPE)
mdz_trueoperation succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_reserve

Reserve nNewCapacity items for string. String Size does not change. Reservation is not made if m_pData is attached using mdz_ansi_attachData()

mdz_bool mdz_ansi_reserve(struct mdz_Ansi* pAnsi, size_t nNewCapacity);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nNewCapacitynew capacity in items to reserve

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_falseif memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif nNewCapacity > Capacity and m_pData is attached using mdz_ansi_attachData() (MDZ_ERROR_ATTACHED)
mdz_trueif nNewCapacity <= Capacity (MDZ_ERROR_CAPACITY)
mdz_true reservation succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_reserveAndInit_async

Reserve nNewCapacity items for string and initializes all items in cItem. May be called only on empty string (with Size == 0). After call, string Size equals to Capacity-1.
Reservation is not made if m_pData is attached using mdz_ansi_attachData() and nNewCapacity > Capacity

mdz_bool mdz_ansi_reserveAndInit_async(struct mdz_Ansi* pAnsi, size_t nNewCapacity, char cItem, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nNewCapacitycapacity to reserve in items
cItemitem for string initialization
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_falseif memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif Size > 0 (MDZ_ERROR_NONEMPTY)
mdz_falseif nNewCapacity > Capacity and m_pData is attached using mdz_ansi_attachData() (MDZ_ERROR_ATTACHED)
mdz_trueif nNewCapacity <= Capacity (MDZ_ERROR_CAPACITY), initialization succeeded
mdz_truereservation and initialization succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_capacity

Return string Capacity in items.

size_t mdz_ansi_capacity(const struct mdz_Ansi* pAnsi);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()

ReturnDescription
SIZE_MAXif pAnsi == NULL
Capacityotherwise

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_size

Return string Size in items.

size_t mdz_ansi_size(const struct mdz_Ansi* pAnsi);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeotherwise

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_resize

Set string Size. Size must be < Capacity (because of terminating 0)

mdz_bool mdz_ansi_resize(struct mdz_Ansi* pAnsi, size_t nNewSize);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nNewSizenew Size to set string in

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_falseif nNewSize >= Capacity (MDZ_ERROR_CAPACITY). String Size is not changed
mdz_trueif succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_offsetFromStart

Return string OffsetFromStart in items.

size_t mdz_ansi_offsetFromStart(const struct mdz_Ansi* pAnsi);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()

ReturnDescription
SIZE_MAXif pAnsi == NULL
OffsetFromStartotherwise

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_isAttachedData

Return if string data is attached.

mdz_bool mdz_ansi_isAttachedData(const struct mdz_Ansi* pAnsi);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_falseif string data is not attached
mdz_trueif string data is attached

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_embedSize

Return string "embedded part" Size in items.

size_t mdz_ansi_embedSize(const struct mdz_Ansi* pAnsi);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()

ReturnDescription
SIZE_MAXif pAnsi == NULL
Result"embedded part" Size otherwise

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_insert_async

Insert nCount items in string. String m_pData and pItems cannot overlap, if reservation is allowed. Size grows on nCount.

mdz_bool mdz_ansi_insert_async(struct mdz_Ansi* pAnsi, size_t nLeftPos, const char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based position to insert. If nLeftPos == Size or -1, items are appended. nLeftPos > Size is not allowed
pcItemsitems to insert
nCountnumber of items to insert or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_ansi_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Size (MDZ_ERROR_BIGLEFT), or nCount is too big (MDZ_ERROR_BIGCOUNT). No insertion is made
mdz_trueinsertion succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_findSingle_async

Find first occurrence of cItem in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_findSingle_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, char cItem, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to search from left. Use 0 to search from the beginning of string
nRightPos0-based end position to search up to. Use Size-1 or -1 to search till the end of string
cItemcharacter to find
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No search is made
Sizeif item(s) not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_find_async

Find first occurrence of pcItems in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_find_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_find_method enFindMethod, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to search from left. Use 0 to search from the beginning of string
nRightPos0-based end position to search up to. Use Size-1 or -1 to search till the end of string
pcItemspointer to items to find
nCountnumber of items to find or 0 if pcItems until 0-terminator should be used
enFindMethodfind method to use. See details in mdz_find_method description
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT), or nCount is too big (MDZ_ERROR_BIGCOUNT), or invalid enFindMethod (MDZ_ERROR_FINDMETHOD). No search is made
Sizeif item(s) not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_firstOf_async

Find first occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_firstOf_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to search from left. Use 0 to search from the beginning of string
nRightPos0-based end position to search up to. Use Size-1 or -1 to search till the end of string
pcItemspointer to items to find
nCountnumber of items to find or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No search is made
Sizeif item(s) not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_firstNotOf_async

Find first non-occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_firstNotOf_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to search from left. Use 0 to search from the beginning of string
nRightPos0-based end position to search up to. Use Size-1 or -1 to serch till the end of string
pcItemspointer to items to find
nCountnumber of items to find or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No search is made
Sizeif non-occurence is not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_rfindSingle_async

Find last occurrence of cItem in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_rfindSingle_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, char cItem, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based end position to find up to. Use 0 to search till the beginning of string
nRightPos0-based start position to find from right. Use Size-1 or -1 to serch from the end of string
cItemcharacter to find
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No search is made
Sizeif item(s) not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_rfind_async

Find last occurrence of pcItems in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_rfind_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_find_method enFindMethod, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based end position to find up to. Use 0 to search till the beginning of string
nRightPos0-based start position to find from right. Use Size-1 or -1 to serch from the end of string
pcItemspointer to items to find
nCountnumber of items to find or 0 if pcItems until 0-terminator should be used
enFindMethodfind method to use. See details in mdz_find_method description
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT), or nCount is too big (MDZ_ERROR_BIGCOUNT), or invalid enFindMethod (MDZ_ERROR_FINDMETHOD). No search is made
Sizeif item(s) not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_lastOf_async

Find last occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_lastOf_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based end position to search up to. Use 0 to search till the beginning of string
nRightPos0-based start position to search from right. Use Size-1 or -1 to serch from the end of string
pcItemspointer to items to find
nCountnumber of items to find or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No search is made
Sizeif item(s) not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_lastNotOf_async

Find last non-occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or string Size if not found, or SIZE_MAX if error.

size_t mdz_ansi_lastNotOf_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based end position to search up to. Use 0 to search till the beginning of string
nRightPos0-based start position to search from right. Use Size-1 or -1 to serch from the end of string
pcItemspointer to items to find
nCountnumber of items to find or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
Sizeif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No search is made
Sizeif non-occurence is not found
Result0-based position of first match

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_removeFrom_async

Remove nCount item(s) starting from 0-based nLeftPos position. After the operation, Capacity doesn't change, Size decreases on nCount.

mdz_bool mdz_ansi_removeFrom_async(struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to remove item(s) from. Use 0 to remove from the beginning of string
nCountnumber of item(s) to remove or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_trueif nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nCount is too big (MDZ_ERROR_BIGCOUNT), or nLeftPos + nCount > Size (MDZ_ERROR_BIGLEFT). No removes are made
mdz_trueoperation succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_remove_async

Remove all ocurrences of nCount item(s) matching to pcItems, residing between nLeftPos and nRightPos. After remove(s) Capacity doesn't change, Size decreases on nCount of removed items.

mdz_bool mdz_ansi_remove_async(struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to remove item(s) from. Use 0 to search from the beginning of string
nRightPos0-based end position to remove item(s) up to. Use Size-1 or -1 to serch till the end of string
pcItemspointer to items to remove
nCountnumber of item(s) to remove or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT), or nCount is too big (MDZ_ERROR_BIGCOUNT). No removes are made
mdz_trueoperation succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_trimLeft_async

Remove items which are contained in pcItems from left, until first non-contained in pcItems item is reached.

mdz_bool mdz_ansi_trimLeft_async(struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to trim item(s) from left. Use 0 to trim from the beginning of string
nRightPos0-based end position to trim item(s) up to. Use Size-1 or -1 to trim till the end of string
pcItemspointer to items to remove
nCountnumber of items to remove or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_trueif string is empty (MDZ_ERROR_EMPTY), or pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No trims are made
mdz_trueoperation succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_trimRight_async

Remove items which are contained in pcItems from right, until first non-contained in pcItems item is reached.

mdz_bool mdz_ansi_trimRight_async(struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based end position to trim item(s) up to. Use 0 to trim till the beginning of string
nRightPos0-based start position to trim item(s) from right. Use Size-1 or -1 to trim from the end of string
pcItemspointer to items to remove
nCountnumber of items to remove or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_trueif string is empty (MDZ_ERROR_EMPTY), or pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No removes are made
mdz_trueoperation succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_trim_async

Remove items which are contained in pcItems from left and from right, until first non-contained in pcItems item is reached.

mdz_bool mdz_ansi_trim_async(struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to trim item(s) from left. Use 0 to trim from the beginning of string
nRightPos0-based start position to trim item(s) from right. Use Size-1 or -1 to trim from the end of string
pcItemspointer to items to remove
nCountnumber of items to remove or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_trueif string is empty (MDZ_ERROR_EMPTY), or pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No removes are made
mdz_trueoperation succeeded, otherwise mdz_false

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_compare_async

Compare content of string with pcItems.

enum mdz_compare_result mdz_ansi_compare_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, const char* pcItems, size_t nCount, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to compare from. Use 0 to compare from the beginning of string
pcItemspointer to items to compare
nCountnumber of items to compare or 0 if pcItems until 0-terminator should be used
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
MDZ_COMPARE_ERRORif pAnsi == NULL
MDZ_COMPARE_NONEQUALif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos >= Size (MDZ_ERROR_BIGLEFT), or nCount is too big (MDZ_ERROR_BIGCOUNT). No comparison is made
MDZ_COMPARE_EQUAL or MDZ_COMPARE_NONEQUALResult of comparison

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_replace_async

Replace every occurence of pcItemsBefore with pcItemsAfter. There should be enough Capacity for replacing data.

mdz_bool mdz_ansi_replace_async(struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItemsBefore, size_t nCountBefore, const char* pcItemsAfter, size_t nCountAfter, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to astring returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to search for replace from. Use 0 to search from the beginning of string
nRightPos0-based end position to search for replace up to. Use Size-1 or -1 to seach till the end of string
pcItemsBeforepointer to items to replace
nCountBeforenumber of items to replace or 0 if pcItems until 0-terminator should be used
pcItemsAfterpointer to items to replace with
nCountAfternumber of items to replace with or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for replacement, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pAnsi == NULL
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_ansi_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItemsBefore == NULL (MDZ_ERROR_ITEMS), or nCountBefore == 0 and pcItemsBefore[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT), or nCountBefore is too big (MDZ_ERROR_BIGCOUNT). No replacements are made
mdz_trueoperation succeeded

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_count_async

Counts number of pcItems substring occurences in string.

size_t mdz_ansi_count_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_find_method enFindMethod, mdz_bool bAllowOverlapped, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to count from. Use 0 to count from the beginning of string
nRightPos0-based end position to count up to. Use Size-1 or -1 to count till the end of string
pcItemsitems/substring to count
nCountSize of substring to count or 0 if pcItems until 0-terminator should be used
enFindMethodfind method to use. See details in mdz_find_method description
bAllowOverlappedmdz_true if overlapped substrings should be counted, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL
0if pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT), or nCount is too big (MDZ_ERROR_BIGCOUNT), or invalid enFindMethod (MDZ_ERROR_FINDMETHOD). No counting is made
Result0-based count of substring occurences. 0 if not found

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_copySubAnsi_async

Fills pSubAnsi with items from pAnsi, starting from nLeftPos and ending with one of pSeparators or nRightPos.

size_t mdz_ansi_copySubAnsi_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nRightPos, const char* pcSeparators, size_t nSeparatorsCount, struct mdz_Ansi* pSubAnsi, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to get items from. Use 0 to start from the beginning of string
nRightPos0-based end position to get items up to. Use Size-1 or -1 to proceed till the end of string
pcSeparatorsseparators to get items up to
nSeparatorsCountnumber of separators or 0 if pcSeparators until 0-terminator should be used
pSubAnsipointer to string where items should be copied. Data in pSubAnsi will be re-reserved to appropriate size if necessary
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL, or pSubAnsi == NULL (MDZ_ERROR_SUBCONTAINER), or reallocation of m_pData in pSubAnsi was necessary but failed (MDZ_ERROR_ALLOCATION)
Sizeif pcSeparators == NULL (MDZ_ERROR_ITEMS), or nSeparatorsCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > nRightPos (MDZ_ERROR_BIGLEFT), or nRightPos >= Size (MDZ_ERROR_BIGRIGHT). No copying is made
Result0-based position after separator if found, or Size if not found

mdz_ansi Reference
mdz_containers API Reference

mdz_ansi_copySubAnsiFrom_async

Fills pSubAnsi with items from pAnsi, starting from nLeftPos and containing nCount items.

size_t mdz_ansi_copySubAnsiFrom_async(const struct mdz_Ansi* pAnsi, size_t nLeftPos, size_t nCount, struct mdz_Ansi* pSubAnsi, struct mdz_asyncData* pAsyncData);

ParameterDescription
pAnsipointer to string returned by mdz_ansi_create() or mdz_ansi_create_attached()
nLeftPos0-based start position to get items from. Use 0 to start from the beginning of string
nCountnumber of items to copy or 0 if pcItems until 0-terminator should be used
pSubAnsipointer to string where items should be copied. Data in pSubAnsi will be re-reserved to appropriate size if necessary
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
SIZE_MAXif pAnsi == NULL, or pSubAnsi == NULL (MDZ_ERROR_SUBCONTAINER), or reallocation of m_pData in pSubAnsi was necessary but failed (MDZ_ERROR_ALLOCATION)
Sizeif nCount == 0 and pcItems[0] == 0 (MDZ_ERROR_ZEROCOUNT), or nCount is too big (MDZ_ERROR_BIGCOUNT), or nLeftPos + nCount > Size (MDZ_ERROR_BIGLEFT). No copying is made
Result0-based position after copied data, or Size if copied until the end of pAnsi

mdz_ansi Reference
mdz_containers API Reference


mdz_wchar Reference

mdz_wchar is dynamically-sized contiguous string, containing C wchar_t characters.

Capacity - how many "wide"-characters memory is reserved for.
Size - how many "wide"-characters are actually used in a string, excluding terminating 0.
Length - actual length of string in symbols, excluding terminating 0. "surrogate pairs" count as 1 symbol.
"reserve/AndReserve" functions allocate/reallocate memory dynamically using malloc()/realloc().
"attach" functionality allows attaching contiguous block of memory to string, for using string functions on it.

UTF-16 "surrogate pairs" are supported and checked.
Unicode "combining characters" are not specially-distinguished and counted as distinct symbols.
Endianness of bytes in "wide"-character - is always endianness of platform.
Size of wchar_t in bytes - is compiler-dependend. At the moment, library supports only wchar_t with size of 2 or 4 bytes.

Init and destroy functions:

mdz_wchar_create
mdz_wchar_create_attached
mdz_wchar_destroy
mdz_wchar_clear
mdz_wchar_attachData

Reserve capacity functions:

mdz_wchar_reserve
mdz_wchar_capacity
mdz_wchar_size
mdz_wchar_length
mdz_wchar_offsetFromStart
mdz_wchar_isAttachedData
mdz_wchar_embedSize

Insert/remove functions:

mdz_wchar_insertWchar_async
mdz_wchar_insertWchar_string_async
mdz_wchar_insertAnsi_async
mdz_wchar_insertAnsi_string_async
mdz_wchar_insertUtf8_async
mdz_wchar_insertUtf8_string_async
mdz_wchar_insertUtf16_async
mdz_wchar_insertUtf16_string_async
mdz_wchar_insertUtf32_async
mdz_wchar_insertUtf32_string_async


mdz_wchar_create

Create empty "wide"-character string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.

struct mdz_Wchar* mdz_wchar_create(size_t nEmbedSize);

ParameterDescription
nEmbedSizesize of "embedded part" of string. There is no "embedded part" if 0

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif memory allocation failed
NULLif sizeof(wchar_t) != 2 (see description in file header)
Resultpointer to string for use in other mdz_wchar functions

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_create_attached

Create empty "wide"-character string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.
Memory for wchar structure starts at position pStart. Size of internal wchar structure (it is usually bigger than mdz_Wchar!) is returned in pSize.

struct mdz_Wchar* mdz_wchar_create_attached(const void* pStart, size_t nAreaSizeBytes, size_t* pOutSize);

ParameterDescription
pStartmemory start position of wchar structure
nAreaSizeBytessize of available memory from pStart in bytes. Should be large enough for internal wchar structure
pOutSizereturned actual size of allocated internal wchar structure in bytes, may be NULL if not needed

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif sizeof(wchar_t) != 2 and sizeof(wchar_t) != 4 (see description in file header)
NULLif pStart == NULL or pSize == NULL
NULLif size in nSize is smaller than size of internal wchar structure
Resultpointer to string for use in other mdz_wchar functions. Normally it equals to pStart

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_destroy

Destroy "wide"-character string including underlying data. After destroying, pointer to string is set to NULL.
If wchar is attached using mdz_wchar_createAttached(), free() will not be called.
If wchar data is attached using mdz_wchar_attachData(), m_pData will not be destroyed.

void mdz_wchar_destroy(struct mdz_Wchar** ppWchar);

ParameterDescription
ppWcharpointer to pointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_clear

Clear m_pData of "wide"-character string with setting Size in 0.

void mdz_wchar_clear(struct mdz_Wchar* pWchar);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create()

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_attachData

Attach pre-allocated data to string, assigning pData to m_pData. If attached, m_pData will not be destroyed in mdz_wchar_destroy()

mdz_bool mdz_wchar_attachData(struct mdz_Wchar* pWchar, wchar_t* pData, size_t nOffsetFromStart, size_t nCapacity, enum mdz_attach_type enAttachType);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
pDatapointer to pre-allocated data to attach
nOffsetFromStartposition in pre-allocated data to attach from. Can be > 0
nCapacityfull capacity pre-allocated data in items
enAttachTypetype of attachment. Only MDZ_ATTACH_ZEROSIZE and MDZ_ATTACH_SIZE_TERMINATOR are allowed

ReturnDescription
mdz_falseif pWchar == NULL
mdz_falseif test-license is used and nCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_falseif pData == NULL (MDZ_ERROR_DATA), or nOffsetFromStart >= nCapacity (MDZ_ERROR_OFFSET), or invalid enAttachType (MDZ_ERROR_ATTACHTYPE)
mdz_falseif enAttachType == MDZ_ATTACH_SIZE_TERMINATOR and pData contains invalid "wide"-characters (MDZ_ERROR_CONTENT)
mdz_trueoperation succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_reserve

Reserve nNewCapacity bytes for string. Size and Length do not change.

mdz_bool mdz_wchar_reserve(struct mdz_Wchar* pWchar, size_t nNewCapacity);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nNewCapacitynew capacity in "wide"-characters to reserve

ReturnDescription
mdz_falseif pWchar == NULL
mdz_falseif memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif test-license is used and nNewCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_true reservation succeeded, or nNewCapacity <= Capacity (MDZ_ERROR_CAPACITY)

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_capacity

Return string Capacity in "wide"-characters.

size_t mdz_wchar_capacity(const struct mdz_Wchar* pWchar);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()

ReturnDescription
SIZE_MAXif pWchar == NULL
Capacityotherwise

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_size

Return string Size in "wide"-characters.

size_t mdz_wchar_size(const struct mdz_Wchar* pWchar);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()

ReturnDescription
SIZE_MAXif pWchar == NULL
Sizeotherwise

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_length

Return string Length in symbols.

size_t mdz_wchar_length(const struct mdz_Wchar* pWchar);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()

ReturnDescription
SIZE_MAXif pWchar == NULL
Lengthotherwise

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_offsetFromStart

Return string OffsetFromStart in "wide"-characters.

size_t mdz_wchar_offsetFromStart(const struct mdz_Wchar* pWchar);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()

ReturnDescription
SIZE_MAXif pWchar == NULL
OffsetFromStartotherwise

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_isAttachedData

Return if string data is attached.

mdz_bool mdz_wchar_isAttachedData(const struct mdz_Wchar* pWchar);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()

ReturnDescription
mdz_falseif pWchar == NULL
mdz_falseif string data is not attached
mdz_trueif string data is attached

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_embedSize

Return string "embedded part" Size in "wide" characters.

size_t mdz_wchar_embedSize(const struct mdz_Wchar* pWchar);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()

ReturnDescription
SIZE_MAXif pWchar == NULL
Result"embedded part" Size otherwise

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertWchar_async

Insert nCount "wide"-characters in string. Size grows on nCount. Length grows on symbols count.

mdz_bool mdz_wchar_insertWchar_async(struct mdz_Wchar* pWchar, size_t nLeftPos, const wchar_t* pwcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pwcItems"wide"-characters to insert
nCountnumber of "wide"-characters to insert
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pwcItems contain invalid "wide"-character(s) (MDZ_ERROR_CONTENT)
mdz_trueif pwcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertWchar_string_async

Insert "wide"-characters string pWcharSource in string. Size grows on nCount. Length grows on symbols count.

mdz_bool mdz_wchar_insertWchar_string_async(struct mdz_Wchar* pWchar, size_t nLeftPos, const struct mdz_Wchar* pWcharSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pWcharSourcepointer to "wide"-characters string to insert. String is returned by mdz_wchar_create() or mdz_wchar_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pWcharSource == NULL (MDZ_ERROR_SOURCE), or pWcharSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertAnsi_async

Insert nCount ASCII/ANSI bytes in string. Characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertAnsi_async(struct mdz_Wchar* pWchar, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsbytes to insert
nCountnumber of bytes to insert
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertAnsi_string_async

Insert ASCII/ANSI string pAnsiSource in string. Characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertAnsi_string_async(struct mdz_Wchar* pWchar, size_t nLeftPos, const struct mdz_Ansi* pAnsiSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pAnsiSourcepointer to ASCII/ANSI string to insert. String is returned by mdz_ansi_create() or mdz_ansi_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pAnsiSource == NULL (MDZ_ERROR_SOURCE), or pAnsiSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertUtf8_async

Insert nCount UTF-8 characters in string. UTF-8 characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertUtf8_async(struct mdz_Wchar* pWchar, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsUTF-8 characters to insert
nCountnumber of UTF-8 characters to insert in bytes
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pcItems contain invalid UTF-8 character(s) (MDZ_ERROR_CONTENT)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertUtf8_string_async

Insert UTF-8 string pUtf8Source in string. UTF-8 characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertUtf8_string_async(struct mdz_Wchar* pWchar, size_t nLeftPos, struct mdz_Utf8* pUtf8Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf8Sourcepointer to UTF-8 string to insert. String is returned by mdz_utf8_create() or mdz_utf8_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf8Source == NULL (MDZ_ERROR_SOURCE), or pUtf8Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertUtf16_async

Insert nCount UTF-16 characters in string. UTF-16 characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertUtf16_async(struct mdz_Wchar* pWchar, size_t nLeftPos, const uint16_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-16 characters to insert
nCountnumber of UTF-16 characters to insert
enEndiannessendianness of UTF-16 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pItems contain invalid UTF-16 character(s) (MDZ_ERROR_CONTENT), or invalid enEndianness (MDZ_ERROR_ENDIANNESS)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertUtf16_string_async

Insert UTF-16 string pUtf16Source in string. UTF-16 characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertUtf16_string_async(struct mdz_Wchar* pWchar, size_t nLeftPos, struct mdz_Utf16* pUtf16Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf16Sourcepointer to UTF-16 string to insert. String is returned by mdz_utf16_create() or mdz_utf16_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf16Source == NULL (MDZ_ERROR_SOURCE), or pUtf16Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertUtf32_async

Insert nCount UTF-32 characters in string. UTF-32 characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertUtf32_async(struct mdz_Wchar* pWchar, size_t nLeftPos, const uint32_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-32 characters to insert
nCountnumber of UTF-32 characters to insert
enEndiannessendianness of UTF-32 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pItems contain invalid UTF-32 character(s) (MDZ_ERROR_CONTENT), or invalid enEndianness (MDZ_ERROR_ENDIANNESS)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference

mdz_wchar_insertUtf32_string_async

Insert UTF-32 string pUtf32Source in string. UTF-32 characters are converted to "wide"-characters before isertion. Size grows on added "wide"-characters count. Length grows on added symbols count.

mdz_bool mdz_wchar_insertUtf32_string_async(struct mdz_Wchar* pWchar, size_t nLeftPos, struct mdz_Utf32* pUtf32Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pWcharpointer to string returned by mdz_wchar_create() or mdz_wchar_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf32Sourcepointer to UTF-32 string to insert. String is returned by mdz_utf32_create() or mdz_utf32_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pWchar is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_wchar_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf32Source == NULL (MDZ_ERROR_SOURCE), or pUtf32Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_wchar Reference
mdz_containers API Reference


mdz_utf8 Reference

mdz_utf8 is dynamically-sized contiguous string, containing UTF-8 characters

If only ASCII/ANSI characters should be stored/processed - use mdz_ansi instead. It is much more speedy.

Capacity - how many bytes of memory is reserved.
Size - how many bytes are actually used in a string, excluding terminating 0.
Length - actual length of string in UTF-8 symbols, excluding terminating 0.

"reserve/AndReserve" functions allocate/reallocate memory dynamically using malloc()/realloc().
"attach" functionality allows attaching contiguous block of memory to string, for using string functions on it.

Unicode "combining characters" are not specially-distinguished and counted as a distinct symbols.

Init and destroy functions:

mdz_utf8_create
mdz_utf8_create_attached
mdz_utf8_destroy
mdz_utf8_clear
mdz_utf8_attachData

Reserve capacity functions:

mdz_utf8_reserve
mdz_utf8_capacity
mdz_utf8_size
mdz_utf8_length
mdz_utf8_offsetFromStart
mdz_utf8_isAttachedData
mdz_utf8_embedSize

Insert/remove functions:

mdz_utf8_insertUtf8_async
mdz_utf8_insertUtf8_string_async
mdz_utf8_insertAnsi_async
mdz_utf8_insertAnsi_string_async
mdz_utf8_insertWchar_async
mdz_utf8_insertWchar_string_async
mdz_utf8_insertUtf16_async
mdz_utf8_insertUtf16_string_async
mdz_utf8_insertUtf32_async
mdz_utf8_insertUtf32_string_async


mdz_utf8_create

Create empty UTF-8 string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.

struct mdz_Utf8* mdz_utf8_create(size_t nEmbedSize);

ParameterDescription
nEmbedSizesize of "embedded part" of string. There is no "embedded part" if 0

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif memory allocation failed
Resultpointer to string for use in other mdz_utf8 functions

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_create_attached

Create empty UTF-8 string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.
Memory for utf8 structure starts at position pStart. Size of internal utf8 structure (it is usually bigger than mdz_Utf8!) is returned in pSize.

struct mdz_Utf8* mdz_utf8_create_attached(const void* pStart, size_t nAreaSizeBytes, size_t* pOutSize);

ParameterDescription
pStartmemory start position of utf8 structure
nAreaSizeBytessize of available memory from pStart in bytes. Should be large enough for internal utf8 structure
pOutSizereturned actual size of placed internal utf8 structure in bytes, may be NULL if not needed

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif pStart == NULL or pSize == NULL
NULLif size in nSize is smaller than size of internal utf8 structure
Resultpointer to string for use in other mdz_utf8 functions. Normally it equals to pStart

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_destroy

Destroy UTF-8 string including underlying data. After destroying, pointer to string is set to NULL.
If utf8 is attached using mdz_utf8_createAttached(), free() will not be called.
If utf8 data is attached using mdz_utf8_attachData(), m_pData will not be destroyed.

void mdz_utf8_destroy(struct mdz_Utf8** ppUtf8);

ParameterDescription
ppUtf8pointer to pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_clear

Clear m_pData of UTF-8 string with setting Size in 0.

void mdz_utf8_clear(struct mdz_Utf8* pUtf8);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_attachData

Attach pre-allocated data to UTF-8 string, assigning pData to m_pData. If attached, m_pData will not be destroyed in mdz_utf8_destroy()

mdz_bool mdz_utf8_attachData(struct mdz_Utf8* pUtf8, unsigned char* pData, size_t nOffsetFromStart, size_t nCapacity, enum mdz_attach_type enAttachType);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
pDatapointer to pre-allocated data to attach
nOffsetFromStartposition in pre-allocated data to attach from. Can be > 0
nCapacityfull capacity pre-allocated data in items
enAttachTypetype of attachment. Only MDZ_ATTACH_ZEROSIZE and MDZ_ATTACH_SIZE_TERMINATOR are allowed

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif test-license is used and nCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_falseif pData == NULL (MDZ_ERROR_DATA), or nOffsetFromStart >= nCapacity (MDZ_ERROR_OFFSET), or invalid enAttachType (MDZ_ERROR_ATTACHTYPE)
mdz_falseif enAttachType == MDZ_ATTACH_SIZE_TERMINATOR and pData contains invalid UTF-8 characters (MDZ_ERROR_CONTENT)
mdz_trueoperation succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_reserve

Reserve nNewCapacity bytes for UTF-8 string. String Size and Length do not change.

mdz_bool mdz_utf8_reserve(struct mdz_Utf8* pUtf8, size_t nNewCapacity);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nNewCapacitynew capacity in bytes to reserve

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif test-license is used and nNewCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_true reservation succeeded, or nNewCapacity <= Capacity (MDZ_ERROR_CAPACITY)

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_capacity

Return string Capacity in bytes.

size_t mdz_utf8_capacity(const struct mdz_Utf8* pUtf8);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create()

ReturnDescription
SIZE_MAXif pUtf8 == NULL
Capacityotherwise

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_size

Return string Size in bytes.

size_t mdz_utf8_size(const struct mdz_Utf8* pUtf8);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()

ReturnDescription
SIZE_MAXif pUtf8 == NULL
Sizeotherwise

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_length

Return string Length in symbols.

size_t mdz_utf8_length(const struct mdz_Utf8* pUtf8);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()

ReturnDescription
SIZE_MAXif pUtf8 == NULL
Lengthotherwise

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_offsetFromStart

Return string OffsetFromStart in bytes.

size_t mdz_utf8_offsetFromStart(const struct mdz_Utf8* pUtf8);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()

ReturnDescription
SIZE_MAXif pUtf8 == NULL
OffsetFromStartotherwise

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_isAttachedData

Return if string data is attached.

mdz_bool mdz_utf8_isAttachedData(const struct mdz_Utf8* pUtf8);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif string data is not attached
mdz_trueif string data is attached

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_embedSize

Return string "embedded part" Size in bytes.

size_t mdz_utf8_embedSize(const struct mdz_Utf8* pUtf8);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()

ReturnDescription
SIZE_MAXif pUtf8 == NULL
Result"embedded part" Size otherwise

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertUtf8_async

Insert nCount UTF-8 bytes in string. Size grows on nCount. Length grows on symbols count.

mdz_bool mdz_utf8_insertUtf8_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsUTF-8 bytes to insert
nCountnumber of UTF-8 bytes to insert or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pcItems contain invalid UTF-8 byte(s) (MDZ_ERROR_CONTENT)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertUtf8_string_async

Insert UTF-8 string pUtf8Source in string. Size grows on nCount. Length grows on symbols count.
This function performs significantly better than mdz_utf8_insertUtf8_async() - because there is no additional validation of inserted string.

mdz_bool mdz_utf8_insertUtf8_string_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const struct mdz_Utf8* pUtf8Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf8Sourcepointer to UTF-8 string to insert. String is returned by mdz_utf8_create() or mdz_utf8_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf8Source == NULL (MDZ_ERROR_SOURCE), or pUtf8Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertAnsi_async

Insert nCount ASCII/ANSI bytes in string. Characters are converted to UTF-8 characters before isertion. Size grows on added bytes. Length grows on added symbols count.

mdz_bool mdz_utf8_insertAnsi_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsbytes to insert
nCountnumber of bytes to insert or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertAnsi_string_async

Insert ASCII/ANSI string pAnsiSource in string. Characters are converted to UTF-8 characters before isertion. Size grows on added bytes. Length grows on added symbols count.

mdz_bool mdz_utf8_insertAnsi_string_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const struct mdz_Ansi* pAnsiSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pAnsiSourcepointer to ASCII/ANSI string to insert. String is returned by mdz_ansi_create() or mdz_ansi_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pAnsiSource == NULL (MDZ_ERROR_SOURCE), or pAnsiSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertWchar_async

Insert nCount "wide"-characters in string. Characters are converted to UTF-8 characters before isertion. Size grows on added bytes. Length grows on symbols count.

mdz_bool mdz_utf8_insertWchar_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const wchar_t* pwcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pwcItems"wide"-characters to insert
nCountnumber of "wide"-characters to insert or 0 if characters until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pwcItems contain invalid "wide"-character(s) (MDZ_ERROR_CONTENT)
mdz_trueif pwcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertWchar_string_async

Insert "wide"-characters string pWcharSource in string. Characters are converted to UTF-8 characters before isertion. Size grows on added bytes. Length grows on symbols count.
For 2-bytes "wide"-characters - see information concerning Unicode "surrogate pairs"/"combining characters" in description of mdz_utf8_insertUtf16_async().
For 4-bytes "wide"-characters - see information concerning Unicode "combining characters" in description of mdz_utf8_insertUtf32_async().

mdz_bool mdz_utf8_insertWchar_string_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const struct mdz_Wchar* pWcharSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pWcharSourcepointer to "wide"-characters string to insert. String is returned by mdz_wchar_create() or mdz_wchar_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pWcharSource == NULL (MDZ_ERROR_SOURCE), or pWcharSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertUtf16_async

Insert nCount UTF-16 characters in string. UTF-16 characters are converted to UTF-8 before isertion. Size grows on added bytes. Length grows on symbols count.
UTF-16 "surrogate pairs" are supported and counted as 1 symbol (4 bytes size).
UTF-16 "combining characters" are not specially-distinguished and counted as a separate UTF-8 symbol.

mdz_bool mdz_utf8_insertUtf16_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const uint16_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-16 characters to insert
nCountnumber of UTF-16 characters to insert or 0 if pcItems until 0-terminator should be used
enEndiannessendianness of UTF-16 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pItems contain invalid UTF-16 character(s) (MDZ_ERROR_CONTENT), or invalid enEndianness (MDZ_ERROR_ENDIANNESS)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertUtf16_string_async

Insert UTF-16 string pUtf16Source in string. UTF-16 characters are converted to UTF-8 before isertion. Size grows on added bytes. Length grows on symbols count.
UTF-16 "surrogate pairs" are supported and counted as 1 symbol (4 bytes size).
UTF-16 "combining characters" are not specially-distinguished and counted as a separate UTF-8 symbol.

mdz_bool mdz_utf8_insertUtf16_string_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const struct mdz_Utf16* pUtf16Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf16Sourcepointer to UTF16 string to insert. String is returned by mdz_utf16_create() or mdz_utf16_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf16Source == NULL (MDZ_ERROR_SOURCE), or pUtf16Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertUtf32_async

Insert nCount UTF-32 characters in string. UTF-32 characters are converted to UTF-8 before isertion. Size grows on added bytes. Length grows on symbols count.
Unicode "combining characters" are not specially-distinguished and counted as a separate UTF-8 symbol.

mdz_bool mdz_utf8_insertUtf32_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const uint32_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-32 characters to insert
nCountnumber of UTF-32 characters to insert or 0 if pcItems until 0-terminator should be used
enEndiannessendianness of UTF-32 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference

mdz_utf8_insertUtf32_string_async

Insert UTF-32 string pUtf32Source in string. UTF-32 characters are converted to UTF-8 before isertion. Size grows on added bytes. Length grows on symbols count.
Unicode "combining characters" are not specially-distinguished and counted as a separate UTF-8 symbol.

mdz_bool mdz_utf8_insertUtf32_string_async(struct mdz_Utf8* pUtf8, size_t nLeftPos, const struct mdz_Utf32* pUtf32Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf8pointer to string returned by mdz_utf8_create() or mdz_utf8_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf32Sourcepointer to UTF-32 string to insert. String is returned by mdz_utf32_create() or mdz_utf32_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf8 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf8_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf32Source == NULL (MDZ_ERROR_SOURCE), or pUtf32Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf8 Reference
mdz_containers API Reference


mdz_utf16 Reference

mdz_utf16 is dynamically-sized contiguous string, containing UTF-16 characters.

Capacity - how many UTF-16 characters memory is reserved for.
Size - how many UTF-16 characters are actually used in a string, excluding terminating 0.
Length - actual length of string in symbols, excluding terminating 0. "surrogate pairs" count as 1 symbol.

"reserve/AndReserve" functions allocate/reallocate memory dynamically using malloc()/realloc().
"attach" functionality allows attaching contiguous block of memory to string, for using string functions on it.

UTF-16 "surrogate pairs" are supported and checked
Unicode "combining characters" are not specially-distinguished and counted as distinct symbols
Endianness of bytes in UTF-16 character - is defined by m_enEndianness and set using enEndianness during string-creation in mdz_utf16_create()

Init and destroy functions:

mdz_utf16_create
mdz_utf16_create_attached
mdz_utf16_destroy
mdz_utf16_clear
mdz_utf16_attachData

Reserve capacity functions:

mdz_utf16_reserve
mdz_utf16_capacity
mdz_utf16_size
mdz_utf16_length
mdz_utf16_endianness
mdz_utf16_offsetFromStart
mdz_utf16_isAttachedData
mdz_utf16_embedSize

Insert/remove functions:

mdz_utf16_insertUtf16_async
mdz_utf16_insertUtf16_string_async
mdz_utf16_insertAnsi_async
mdz_utf16_insertAnsi_string_async
mdz_utf16_insertWchar_async
mdz_utf16_insertWchar_string_async
mdz_utf16_insertUtf8_async
mdz_utf16_insertUtf8_string_async
mdz_utf16_insertUtf32_async
mdz_utf16_insertUtf32_string_async


mdz_utf16_create

Create empty UTF-16 string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.

struct mdz_Utf16* mdz_utf16_create(size_t nEmbedSize, enum mdz_endianness enEndianness);

ParameterDescription
nEmbedSizesize of "embedded part" of string. There is no "embedded part" if 0
enEndiannessendianness of string. Should be MDZ_ENDIAN_LITTLE or MDZ_ENDIAN_BIG

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif memory allocation failed
NULLif invalid enEndianness
Resultpointer to string for use in other mdz_utf16 functions

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_create_attached

Create empty UTF-16 string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.
Memory for utf16 structure starts at position pStart. Size of internal utf16 structure (it is usually bigger than mdz_Utf16!) is returned in pSize.

struct mdz_Utf16* mdz_utf16_create_attached(const void* pStart, enum mdz_endianness enEndianness, size_t nAreaSizeBytes, size_t* pOutSize);

ParameterDescription
pStartmemory start position of utf16 structure
enEndiannessendianness of string. Should be MDZ_ENDIAN_LITTLE or MDZ_ENDIAN_BIG
nAreaSizeBytessize of available memory from pStart in bytes. Should be large enough for internal utf16 structure
pOutSizereturned actual size of allocated internal utf16 structure in bytes, may be NULL if not needed

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif invalid enEndianness
NULLif pStart == NULL or pSize == NULL
NULLif size in nSize is smaller than size of internal utf16 structure
Resultpointer to string for use in other mdz_utf16 functions. Normally it equals to pStart

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_destroy

Destroy UTF-16 string including underlying data. After destroying, pointer to string is set to NULL.
If utf16 is attached using mdz_utf16_createAttached(), free() will not be called.
If utf16 data is attached using mdz_utf16_attachData(), m_pData will not be destroyed.

void mdz_utf16_destroy(struct mdz_Utf16** ppUtf16);

ParameterDescription
ppUtf16pointer to pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_clear

Clear m_pData of UTF-16 string with setting Size in 0.

void mdz_utf16_clear(struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create()

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_attachData

Attach pre-allocated data to UTF-16 string, assigning pData to m_pData. If attached, m_pData will not be destroyed in mdz_utf16_destroy()

mdz_bool mdz_utf16_attachData(struct mdz_Utf16* pUtf16, uint16_t* pData, size_t nOffsetFromStart, size_t nCapacity, enum mdz_attach_type enAttachType, enum mdz_endianness enEndianness);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
pDatapointer to pre-allocated data to attach
nOffsetFromStartposition in pre-allocated data to attach from. Can be > 0
nCapacityfull capacity pre-allocated data in items
enAttachTypetype of attachment. Only MDZ_ATTACH_ZEROSIZE and MDZ_ATTACH_SIZE_TERMINATOR are allowed
enEndiannessendianness of UTF-16 characters in pData. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"

ReturnDescription
mdz_falseif pUtf16 == NULL
mdz_falseif test-license is used and nCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_falseif pData == NULL (MDZ_ERROR_DATA), or nOffsetFromStart >= nCapacity (MDZ_ERROR_OFFSET), or invalid enAttachType (MDZ_ERROR_ATTACHTYPE), or invalid pData endianness (MDZ_ERROR_ENDIANNESS)
mdz_falseif enAttachType == MDZ_ATTACH_SIZE_TERMINATOR and pData contains invalid UTF-16 characters (MDZ_ERROR_CONTENT)
mdz_trueoperation succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_reserve

Reserve nNewCapacity bytes for UTF-16 string. Size and Length do not change.

mdz_bool mdz_utf16_reserve(struct mdz_Utf16* pUtf16, size_t nNewCapacity);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nNewCapacitynew capacity in UTF-16 characters to reserve

ReturnDescription
mdz_falseif pUtf16 == NULL
mdz_falseif memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif test-license is used and nNewCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_true reservation succeeded, or nNewCapacity <= Capacity (MDZ_ERROR_CAPACITY)

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_capacity

Return string Capacity in UTF-16 characters.

size_t mdz_utf16_capacity(const struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

ReturnDescription
SIZE_MAXif pUtf16 == NULL
Capacityotherwise

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_size

Return string Size in UTF-16 characters.

size_t mdz_utf16_size(const struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

ReturnDescription
SIZE_MAXif pUtf16 == NULL
Sizeotherwise

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_length

Return string Length in symbols.

size_t mdz_utf16_length(const struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

ReturnDescription
SIZE_MAXif pUtf16 == NULL
Lengthotherwise

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_endianness

Return string endianness.

enum mdz_endianness mdz_utf16_endianness(const struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

ReturnDescription
MDZ_ENDIAN_ERRORif pUtf16 == NULL
Endiannessotherwise

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_offsetFromStart

Return string OffsetFromStart in UTF-16 characters.

size_t mdz_utf16_offsetFromStart(const struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

ReturnDescription
SIZE_MAXif pUtf16 == NULL
OffsetFromStartotherwise

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_isAttachedData

Return if string data is attached.

mdz_bool mdz_utf16_isAttachedData(const struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

ReturnDescription
mdz_falseif pUtf16 == NULL
mdz_falseif string data is not attached
mdz_trueif string data is attached

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_embedSize

Return string "embedded part" Size in UTF-16 characters.

size_t mdz_utf16_embedSize(const struct mdz_Utf16* pUtf16);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()

ReturnDescription
SIZE_MAXif pUtf16 == NULL
Result"embedded part" Size otherwise

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertUtf16_async

Insert nCount UTF-16 characters in string. Size grows on nCount. Length grows on symbols count.

mdz_bool mdz_utf16_insertUtf16_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const uint16_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-16 characters to insert
nCountnumber of UTF-16 characters to insert or 0 if pcItems until 0-terminator should be used
enEndiannessendianness of UTF-16 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pItems contain invalid UTF-16 character(s) (MDZ_ERROR_CONTENT), or invalid enEndianness (MDZ_ERROR_ENDIANNESS)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertUtf16_string_async

Insert UTF-16 string pUtf16Source in string. Size grows on nCount. Length grows on symbols count.
This function performs significantly better than mdz_utf16_insertUtf16_async() - because there is no additional validation of inserted string.

mdz_bool mdz_utf16_insertUtf16_string_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const struct mdz_Utf16* pUtf16Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf16Sourcepointer to UTF-16 string to insert. String is returned by mdz_utf16_create() or mdz_utf16_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf16Source == NULL (MDZ_ERROR_SOURCE), or pUtf16Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertAnsi_async

Insert nCount ASCII/ANSI bytes in string. Characters are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.

mdz_bool mdz_utf16_insertAnsi_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsbytes to insert
nCountnumber of bytes to insert or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertAnsi_string_async

Insert ASCII/ANSI string pAnsiSource in string. Characters are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.

mdz_bool mdz_utf16_insertAnsi_string_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const struct mdz_Ansi* pAnsiSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pAnsiSourcepointer to ASCII/ANSI string to insert. String is returned by mdz_ansi_create() or mdz_ansi_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pAnsiSource == NULL (MDZ_ERROR_SOURCE), or pAnsiSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertWchar_async

Insert nCount "wide"-characters in string. Characters are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.

mdz_bool mdz_utf16_insertWchar_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const wchar_t* pwcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pwcItems"wide"-characters to insert
nCountnumber of "wide"-characters to insert or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertWchar_string_async

Insert "wide"-characters string pWcharSource in string. Characters are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.
This function performs significantly better than mdz_utf16_insertWchar_async() - because there is no additional validation of inserted string.

mdz_bool mdz_utf16_insertWchar_string_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const struct mdz_Wchar* pWcharSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pWcharSourcepointer to "wide"-characters string to insert. String is returned by mdz_wchar_create() or mdz_wchar_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pWcharSource == NULL (MDZ_ERROR_SOURCE), or pWcharSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertUtf8_async

Insert nCount UTF-8 bytes in string. UTF-8 bytes are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.

mdz_bool mdz_utf16_insertUtf8_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsUTF-8 characters to insert
nCountnumber of UTF-8 characters to insert in bytes or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pcItems contain invalid UTF-8 byte(s) (MDZ_ERROR_CONTENT)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertUtf8_string_async

Insert UTF-8 string pUtf8Source in string. UTF-8 bytes are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.

mdz_bool mdz_utf16_insertUtf8_string_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const struct mdz_Utf8* pUtf8Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf8Sourcepointer to UTF-8 string to insert. String is returned by mdz_utf8_create() or mdz_utf8_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf8Source == NULL (MDZ_ERROR_SOURCE), or pUtf8Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertUtf32_async

Insert nCount UTF-32 characters in string. UTF-32 characters are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.

mdz_bool mdz_utf16_insertUtf32_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const uint32_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-32 characters to insert
nCountnumber of UTF-32 characters to insert or 0 if pcItems until 0-terminator should be used
enEndiannessendianness of UTF-32 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pItems contain invalid UTF-8 character(s) (MDZ_ERROR_CONTENT), or invalid enEndianness (MDZ_ERROR_ENDIANNESS)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference

mdz_utf16_insertUtf32_string_async

Insert UTF-32 string pUtf32Source in string. UTF-32 characters are converted to UTF-16 characters before isertion. Size grows on added UTF-16 characters count. Length grows on added symbols count.

mdz_bool mdz_utf16_insertUtf32_string_async(struct mdz_Utf16* pUtf16, size_t nLeftPos, const struct mdz_Utf32* pUtf32Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf16pointer to string returned by mdz_utf16_create() or mdz_utf16_create_attached()
nLeftPos0-based position to insert in symbols. "surrogate pairs" count as 1 symbol. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf32Sourcepointer to UTF-32 string to insert. String is returned by mdz_utf32_create() or mdz_utf32_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf16 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf16_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf32Source == NULL (MDZ_ERROR_SOURCE), or pUtf32Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf16 Reference
mdz_containers API Reference


mdz_utf32 Reference

mdz_utf32 is dynamically-sized contiguous string, containing UTF-32 characters.

Capacity - how many UTF-32 characters memory is reserved for.
Size - how many UTF-32 characters are actually used in a string, excluding terminating 0.
Length - actual length of string in symbols, excluding terminating 0.

"reserve/AndReserve" functions allocate/reallocate memory dynamically using malloc()/realloc().
"attach" functionality allows attaching contiguous block of memory to string, for using string functions on it.

Unicode "combining characters" are not specially-distinguished and counted as distinct symbols
Endianness of bytes in UTF-32 character - is defined by m_enEndianness and set using enEndianness during string-creation in mdz_utf32_create()

Init and destroy functions:

mdz_utf32_create
mdz_utf32_create_attached
mdz_utf32_destroy
mdz_utf32_clear
mdz_utf32_attachData

Reserve capacity functions:

mdz_utf32_reserve
mdz_utf32_capacity
mdz_utf32_size
mdz_utf32_length
mdz_utf32_endianness
mdz_utf32_offsetFromStart
mdz_utf32_isAttachedData
mdz_utf32_embedSize

Insert/remove functions:

mdz_utf32_insertUtf32_async
mdz_utf32_insertUtf32_string_async
mdz_utf32_insertAnsi_async
mdz_utf32_insertAnsi_string_async
mdz_utf32_insertWchar_async
mdz_utf32_insertWchar_string_async
mdz_utf32_insertUtf8_async
mdz_utf32_insertUtf8_string_async
mdz_utf32_insertUtf16_async
mdz_utf32_insertUtf16_string_async


mdz_utf32_create

Create empty UTF-32 string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.

struct mdz_Utf32* mdz_utf32_create(size_t nEmbedSize, enum mdz_endianness enEndianness);

ParameterDescription
nEmbedSizesize of "embedded part" of string. There is no "embedded part" if 0
enEndiannessendianness of string. Should be MDZ_ENDIAN_LITTLE or MDZ_ENDIAN_BIG

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif memory allocation failed
NULLif invalid enEndianness
Resultpointer to string for use in other mdz_utf32 functions

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_create_attached

Create empty UTF-32 string with Capacity == 1 (for 0-terminator), Size == 0 and Length == 0.
Memory for utf32 structure starts at position pStart. Size of internal utf32 structure (it is usually bigger than mdz_Utf32!) is returned in pSize.

struct mdz_Utf32* mdz_utf32_create_attached(const void* pStart, enum mdz_endianness enEndianness, size_t nAreaSizeBytes, size_t* pOutSize);

ParameterDescription
pStartmemory start position of utf32 structure
enEndiannessendianness of string. Should be MDZ_ENDIAN_LITTLE or MDZ_ENDIAN_BIG
nAreaSizeBytessize of available memory from pStart in bytes. Should be large enough for internal utf32 structure
pOutSizereturned actual size of allocated internal utf32 structure in bytes, may be NULL if not needed

ReturnDescription
NULLif library is not initialized with mdz_string_init() call
NULLif invalid enEndianness
NULLif pStart == NULL or pSize == NULL
NULLif size in nSize is smaller than size of internal utf32 structure
Resultpointer to string for use in other mdz_utf32 functions. Normally it equals to pStart

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_destroy

Destroy UTF-32 string including underlying data. After destroying, pointer to string is set to NULL.
If utf32 is attached using mdz_utf32_createAttached(), free() will not be called.
If utf32 data is attached using mdz_utf32_attachData(), m_pData will not be destroyed.

void mdz_utf32_destroy(struct mdz_Utf32** ppUtf32);

ParameterDescription
ppUtf32pointer to pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_clear

Clear m_pData of UTF-32 string with setting Size in 0.

void mdz_utf32_clear(struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create()

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_attachData

Attach pre-allocated data to UTF-32 string, assigning pData to m_pData. If attached, m_pData will not be destroyed in mdz_utf32_destroy()

mdz_bool mdz_utf32_attachData(struct mdz_Utf32* pUtf32, uint32_t* pData, size_t nOffsetFromStart, size_t nCapacity, enum mdz_attach_type enAttachType, enum mdz_endianness enEndianness);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
pDatapointer to pre-allocated data to attach
nOffsetFromStartposition in pre-allocated data to attach from. Can be > 0
nCapacityfull capacity pre-allocated data in items
enAttachTypetype of attachment. Only MDZ_ATTACH_ZEROSIZE and MDZ_ATTACH_SIZE_TERMINATOR are allowed
enEndiannessendianness of UTF-32 characters in pData. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"

ReturnDescription
mdz_falseif pUtf32 == NULL
mdz_falseif test-license is used and nCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_falseif pData == NULL (MDZ_ERROR_DATA), or nOffsetFromStart >= nCapacity (MDZ_ERROR_OFFSET), or invalid enAttachType (MDZ_ERROR_ATTACHTYPE), or invalid pData endianness (MDZ_ERROR_ENDIANNESS)
mdz_trueoperation succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_reserve

Reserve nNewCapacity bytes for UTF-32 string. Size and Length do not change.

mdz_bool mdz_utf32_reserve(struct mdz_Utf32* pUtf32, size_t nNewCapacity);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nNewCapacitynew capacity in UTF-32 characters to reserve

ReturnDescription
mdz_falseif pUtf32 == NULL
mdz_falseif memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif test-license is used and nNewCapacity > 1200 (MDZ_ERROR_TEST_CAPACITY)
mdz_true reservation succeeded, or nNewCapacity <= Capacity (MDZ_ERROR_CAPACITY)

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_capacity

Return string Capacity in UTF-32 characters.

size_t mdz_utf32_capacity(const struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

ReturnDescription
SIZE_MAXif pUtf32 == NULL
Capacityotherwise

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_size

Return string Size in UTF-32 characters.

size_t mdz_utf32_size(const struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

ReturnDescription
SIZE_MAXif pUtf32 == NULL
Sizeotherwise

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_length

Return string length in symbols.

size_t mdz_utf32_length(const struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

ReturnDescription
SIZE_MAXif pUtf32 == NULL
Sizeotherwise

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_endianness

Return string endianness.

enum mdz_endianness mdz_utf32_endianness(const struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

ReturnDescription
MDZ_ENDIAN_ERRORif pUtf32 == NULL
Endiannessotherwise

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_offsetFromStart

Return string OffsetFromStart in UTF-32 characters.

size_t mdz_utf32_offsetFromStart(const struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

ReturnDescription
SIZE_MAXif pUtf32 == NULL
OffsetFromStartotherwise

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_isAttachedData

Return if string data is attached.

mdz_bool mdz_utf32_isAttachedData(const struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

ReturnDescription
mdz_falseif pUtf32 == NULL
mdz_falseif string data is not attached
mdz_trueif string data is attached

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_embedSize

Return string "embedded part" Size in UTF-32 characters.

size_t mdz_utf32_embedSize(const struct mdz_Utf32* pUtf32);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()

ReturnDescription
SIZE_MAXif pUtf32 == NULL
Result"embedded part" Size otherwise

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertUtf32_async

Insert nCount UTF-32 characters in string. Size grows on nCount. Length grows on symbols count.

mdz_bool mdz_utf32_insertUtf32_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const uint32_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-32 characters to insert
nCountnumber of UTF-32 characters to insert or 0 if pcItems until 0-terminator should be used
enEndiannessendianness of UTF-32 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertUtf32_string_async

Insert UTF-32 string pUtf32Source in string. Size grows on nCount. Length grows on symbols count.
This function performs significantly better than mdz_utf32_insertUtf32_async() - because there is no additional validation of inserted string.

mdz_bool mdz_utf32_insertUtf32_string_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const struct mdz_Utf32* pUtf32Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf32Sourcepointer to UTF-32 string to insert. String is returned by mdz_utf32_create() or mdz_utf32_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif invalid enEndianness (MDZ_ERROR_ENDIANNESS)
mdz_trueif pUtf32Source == NULL (MDZ_ERROR_SOURCE), or pUtf32Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertAnsi_async

Insert nCount ASCII/ANSI bytes in string. Characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on added symbols count.

mdz_bool mdz_utf32_insertAnsi_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsbytes to insert
nCountnumber of bytes to insert or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertAnsi_string_async

Insert ASCII/ANSI string pAnsiSource in string. Characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on added symbols count.

mdz_bool mdz_utf32_insertAnsi_string_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const struct mdz_Ansi* pAnsiSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pAnsiSourcepointer to ASCII/ANSI string to insert. String is returned by mdz_ansi_create() or mdz_ansi_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pAnsiSource == NULL (MDZ_ERROR_SOURCE), or pAnsiSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertWchar_async

Insert nCount "wide"-characters in string. Characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on added symbols count.

mdz_bool mdz_utf32_insertWchar_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const wchar_t* pwcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pwcItems"wide"-characters to insert
nCountnumber of characters to insert in bytes or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertWchar_string_async

Insert "wide"-characters string pWcharSource in string. Characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on added symbols count.

mdz_bool mdz_utf32_insertWchar_string_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const struct mdz_Wchar* pWcharSource, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pWcharSourcepointer to "wide"-characters string to insert. String is returned by mdz_wchar_create() or mdz_wchar_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pWcharSource == NULL (MDZ_ERROR_SOURCE), or pWcharSource.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertUtf8_async

Insert nCount UTF-8 characters in string. UTF-8 characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on added symbols count.

mdz_bool mdz_utf32_insertUtf8_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const unsigned char* pcItems, size_t nCount, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pcItemsUTF-8 characters to insert
nCountnumber of UTF-8 characters to insert in bytes or 0 if pcItems until 0-terminator should be used
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pcItems contain invalid UTF-8 character(s) (MDZ_ERROR_CONTENT)
mdz_trueif pcItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertUtf8_string_async

Insert UTF-8 string pUtf8Source in string. UTF-8 characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on added symbols count.

mdz_bool mdz_utf32_insertUtf8_string_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const struct mdz_Utf8* pUtf8Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf8Sourcepointer to UTF-8 string to insert. String is returned by mdz_utf8_create() or mdz_utf8_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 is NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf8Source == NULL (MDZ_ERROR_SOURCE), or pUtf8Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertUtf16_async

Insert nCount UTF-16 characters in string. Characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on symbols count.

mdz_bool mdz_utf32_insertUtf16_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const uint16_t* pItems, size_t nCount, enum mdz_endianness enEndianness, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pItemsUTF-16 items to insert
nCountnumber of UTF-16 items to insert or 0 if pcItems until 0-terminator should be used
enEndiannessendianness of UTF-16 characters in pItems. Can be MDZ_ENDIAN_LITTLE for "little-endian" or MDZ_ENDIAN_BIG for "big-endian"
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_falseif pItems contain invalid 2-byte character(s) (MDZ_ERROR_CONTENT), or invalid enEndianness (MDZ_ERROR_ENDIANNESS)
mdz_trueif pItems == NULL (MDZ_ERROR_ITEMS), or nCount == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference

mdz_utf32_insertUtf16_string_async

Insert UTF-16 string pUtf16Source in string. Characters are converted to UTF-32 characters before isertion. Size grows on added UTF-32 characters count. Length grows on symbols count.

mdz_bool mdz_utf32_insertUtf16_string_async(struct mdz_Utf32* pUtf32, size_t nLeftPos, const struct mdz_Utf16* pUtf16Source, mdz_bool bReserve, struct mdz_asyncData* pAsyncData);

ParameterDescription
pUtf32pointer to string returned by mdz_utf32_create() or mdz_utf32_create_attached()
nLeftPos0-based position to insert in symbols. If nLeftPos == Length or -1, items are appended. nLeftPos > Length is not allowed
pUtf16Sourcepointer to UTF-16 string to insert. String is returned by mdz_utf16_create() or mdz_utf16_create_attached()
bReserveif mdz_true reserve capacity when there is not enough space for insertion, otherwise mdz_false
pAsyncDatapointer to shared async data for asynchronous call, or NULL if call should be synchronous

ReturnDescription
mdz_falseif pUtf32 == NULL
mdz_falseif bReserve == mdz_true and memory allocation failed (MDZ_ERROR_ALLOCATION)
mdz_falseif bReserve == mdz_true and there is not enough capacity for inserted data, but m_pData is attached using mdz_utf32_attachData() (MDZ_ERROR_ATTACHED)
mdz_falseif bReserve == mdz_false and there is not enough free Capacity in the string (MDZ_ERROR_CAPACITY)
mdz_trueif pUtf16Source == NULL (MDZ_ERROR_SOURCE), or pUtf16Source.Size == 0 (MDZ_ERROR_ZEROCOUNT), or nLeftPos > Length (MDZ_ERROR_BIGLEFT). No insertion is made
mdz_trueinsertion succeeded

mdz_utf32 Reference
mdz_containers API Reference
Copyright Ⓒ 2017 - 2020 maxdz Software GmbH. All rights reserved.
Site content generated by mdzWebSiteGenerator Ⓒ 2017 - 2020 maxdz Software GmbH. All rights reserved.