dup_string_utf16

Free-function: g_free

Returns a newly-allocated copy of the current data position if there is a NUL-terminated UTF-16 string in the data (this could be an empty string as well), and advances the current position.

No input checking for valid UTF-16 is done. This function is endianness agnostic - you should not assume the UTF-16 characters are in host endianness.

This function will fail if no NUL-terminator was found in in the data.

Note: there is no peek or get variant of this function to ensure correct byte alignment of the UTF-16 string.

Parameters:

this	a ByteReader instance
str	address of a uint16 pointer variable in which to store the result

Returns:

true if a string could be read, false otherwise. The string put into str must be freed with g_free when no longer needed.