OpenersNotesSection(Spacer1)Details

WSGetIntegerList() allocates memory for the array of integers. You must call WSDisownIntegerList() to disown this memory. If WSGetIntegerList() fails and the function's return value indicates an error, do not call WSDisownIntegerList() on the contents of a.

WSGetIntegerList() returns immutable data.

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

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

WSGetIntegerList() is equivalent to (NonWLLink[WSGetInteger32List(), paclet:ref/c/WSGetInteger32List]).

OpenersPrimaryExamplesSection(Spacer1)Examples  (1)

OpenersExampleSection0(Spacer1)Basic Examples  (1)

#include "wstp.h"

/* read a list of integers from a link */

void f(WSLINK lp)
{
	int *data;
	long length;

	if(! WSGetIntegerList(lp, &data, &length))
		{
			/* unable to read the integer list from lp */
			return;
		}

	/* ... */

	WSDisownIntegerList(lp, data, length);
}

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

({{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 Integers, paclet:guide/WSTPCFunctionsForExchangingIntegers])}, {▪(RefLinkPlain[WSTP C Functions for Exchanging Lists, paclet:guide/WSTPCFunctionsForExchangingLists])}, {▪(RefLinkPlain[WSTP C Language Functions, paclet:guide/WSTPCLanguageFunctions])}})}})