OpenersNotesSection(Spacer1)Details

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

WSGetString() returns immutable data.

WSGetString() creates a string that is terminated by ∖0.

WSGetString() stores single ∖ characters from the Wolfram Language as pairs of characters ∖∖.

WSGetString() stores special characters from the Wolfram Language in a private format.

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

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

void f(WSLINK lp)
{
	const char *string;

	if(! WSGetString(lp, &string))
		{
			/* unable to read the string from lp */
			return;
		}

	/* ... */

	WSReleaseString(lp, string);
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[WSGetByteString(), paclet:ref/c/WSGetByteString])  ▪  (NonWLLink[WSGetUCS2String(), paclet:ref/c/WSGetUCS2String])  ▪  (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])}, {▪(RefLinkPlain[WSTP C Language Functions, paclet:guide/WSTPCLanguageFunctions])}})}})