OpenersNotesSection(Spacer1)Details

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

WSGetUCS2String() returns immutable data.

WSGetUCS2String() stores all characters directly in 16-bit UCS-2 form.

ASCII characters are stored with a null high-order byte.

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

WSGetUCS2String() 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 UCS-2 encoded string from a link */

void f(WSLINK lp)
{
	const unsigned short *string;
	int length;

	if(! WSGetUCS2String(lp, &string, &length))
		{
			/* unable to read the UCS-2 string */
			return;
		}

	/* ... */

	WSReleaseUCS2String(lp, string, length);
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[WSGetString(), paclet:ref/c/WSGetString])  ▪  (NonWLLink[WSGetByteString(), paclet:ref/c/WSGetByteString])  ▪  (NonWLLink[WSGetUTF8String(), paclet:ref/c/WSGetUTF8String])  ▪  (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 Data, paclet:guide/WSTPCFunctionsForExchangingData])}, {▪(RefLinkPlain[WSTP C Functions for Exchanging Strings, paclet:guide/WSTPCFunctionsForExchangingStrings])}})}})