OpenersNotesSection(Spacer1)Details

WSGetInteger8List() allocates memory for the array of integers. You must call (NonWLLink[WSReleaseInteger8List(), paclet:ref/c/WSReleaseInteger8List]) to release this memory. If WSGetInteger8List() fails and the function's return value indicates an error, do not call (NonWLLink[WSReleaseInteger8List(), paclet:ref/c/WSReleaseInteger8List]) on the contents of i.

WSGetInteger8List() returns immutable data.

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

WSGetInteger8List() 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"

/* A function for reading a list of 8-bit integers from a link */

void f(WSLINK l)
{
	unsigned char *data;
	int length;
	
	if(! WSGetInteger8List(l, &data, &length))
	{ /* Unable to read the integer list from the link */ }

	/* ... */

	WSReleaseInteger8List(l, data, length);
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[WSReleaseInteger8List(), paclet:ref/c/WSReleaseInteger8List])  ▪  (NonWLLink[WSGetInteger16List(), paclet:ref/c/WSGetInteger16List])  ▪  (NonWLLink[WSGetInteger32List(), paclet:ref/c/WSGetInteger32List])  ▪  (NonWLLink[WSGetInteger64List(), paclet:ref/c/WSGetInteger64List])}})}})

({{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])}})}})