OpenersNotesSection(Spacer1)Details

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

WSGetUTF8String() returns immutable data.

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

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

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

WSGetUTF8String() is declared in the WSTP header file (RefLink[wstp.h, paclet:ref/file/wstp.h]).

OpenersPrimaryExamplesSection(Spacer1)Examples  (1)

OpenersExampleSection0(Spacer1)Basic Examples  (1)

#include "wstp.h"

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

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

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

	/* use the string */

	WSReleaseUTF8String(lp, string, bytes);
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[WSGetString(), paclet:ref/c/WSGetString])  ▪  (NonWLLink[WSGetByteString(), paclet:ref/c/WSGetByteString])  ▪  (NonWLLink[WSGetUCS2String(), paclet:ref/c/WSGetUCS2String])  ▪  (NonWLLink[WSGetUTF16String(), paclet:ref/c/WSGetUTF16String])  ▪  (NonWLLink[WSGetUTF32String(), paclet:ref/c/WSGetUTF32String])}})}})

({{DocumentationFooterIconsRelatedTutorial.png, ({{Tutorials}, {▪(RefLinkPlain[Manipulating Expressions in External Programs, paclet:tutorial/ManipulatingExpressionsInExternalPrograms])}, {▪(RefLinkPlain[Handling Lists, Arrays and Other Expressions, paclet:tutorial/HandlingListsArraysAndOtherExpressions])}, {▪(RefLinkPlain[Portability of WSTP Programs, paclet:tutorial/PortabilityOfWSTPPrograms])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Mac OS X), paclet:tutorial/WSTPDeveloperGuide-MacintoshOverview])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Unix and Linux), paclet:tutorial/WSTPDeveloperGuide-UnixOverview])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Windows), paclet:tutorial/WSTPDeveloperGuide-WindowsOverview])}})}})

({{DocumentationFooterIconsRelatedGuide.png, ({{Related Guides}, {▪(RefLinkPlain[Alphabetical Listing of WSTP C Functions, paclet:guide/AlphabeticalListingOfWSTPCFunctions])}, {▪(RefLinkPlain[WSTP C Functions for Exchanging Strings, paclet:guide/WSTPCFunctionsForExchangingStrings])}})}})