OpenersNotesSection(Spacer1)Details

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

MLGetUTF8String() returns immutable data.

MLGetUTF8String() stores all characters directly in the UTF-8 Unicode encoding form.

MLGetUTF8String() 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 MLGetUTF8String() fails.

MLGetUTF8String() 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-8 encoded string from a link */

void f(MLINK lp)
{
	const unsigned char *string;
	int bytes;
	int characters;

	if(! MLGetUTF8String(lp, &string, &bytes, &characters))
		{
			/* unable to read the UTF-8 string from lp */
			return;
		}

	/* use the string */

	MLReleaseUTF8String(lp, string, bytes);
}

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

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