OpenersNotesSection(Spacer1)Details

MLGetUTF32String() allocates memory for the character string. You must call (NonWLLink[MLReleaseUTF32String(), paclet:ref/c/MLReleaseUTF32String]) to disown this memory. If MLGetUTF32String() fails and the function's return value indicates an error, do not call (NonWLLink[MLReleaseUTF32String(), paclet:ref/c/MLReleaseUTF32String]) on the contents of s.

MLGetUTF32String() returns immutable data.

MLGetUTF32String() stores all characters directly in the UTF-32 encoding form.

The string s returned by MLGetUTF32String() begins with a byte order mark.

The length of the string len includes the byte order mark.

MLGetUTF32String() returns 0 in the event of an error, and a nonzero value if the function succeeds.

Use (NonWLLink[MLError(), paclet:ref/c/MLError]) to retrieve the error code if MLGetUTF32String() fails.

MLGetUTF32String() is declared in the MathLink header file (RefLink[mathlink.h, paclet:ref/file/mathlink.h]).

OpenersPrimaryExamplesSection(Spacer1)Examples  (1)

OpenersExampleSection0(Spacer1)Basic Examples  (1)

#include "mathlink.h"

/* read a UTF-32 encoded string from a link */

void f(MLINK lp)
{
	const unsigned int *string;
	int len;

	if(! MLGetUTF32String(lp, &string, &len))
		{
			/* unable to read the UTF-32 string from lp */
			return;
		}

	/* ... */

	MLReleaseUTF32String(lp, string, len);
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[MLGetString(), paclet:ref/c/MLGetString])  ▪  (NonWLLink[MLGetByteString(), paclet:ref/c/MLGetByteString])  ▪  (NonWLLink[MLGetUCS2String(), paclet:ref/c/MLGetUCS2String])  ▪  (NonWLLink[MLGetUTF8String(), paclet:ref/c/MLGetUTF8String])  ▪  (NonWLLink[MLGetUTF16String(), paclet:ref/c/MLGetUTF16String])}})}})

({{DocumentationFooterIconsRelatedTutorial.png, ({{Tutorials}, {▪(RefLinkPlain[Manipulating Expressions in External Programs, paclet:tutorial/ManipulatingExpressionsInExternalPrograms])}, {▪(RefLinkPlain[Handling Lists, Arrays and Other Expressions, paclet:tutorial/HandlingListsArraysAndOtherExpressions])}})}})