OpenersNotesSection(Spacer1)Details

The array a is laid out in memory like a C array declared as int a[m][n]….

heads gives a list of character strings corresponding to the names of symbols that appear as heads at each level in the array.

WSGetInteger32Array() allocates memory which must be disowned by calling (NonWLLink[WSReleaseInteger32Array(), paclet:ref/c/WSReleaseInteger32Array]). If WSGetInteger32Array() fails and the function's return value indicates an error, do not call (NonWLLink[WSReleaseInteger32Array(), paclet:ref/c/WSReleaseInteger32Array])on the contents of a.

WSGetInteger32Array() returns immutable data.

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

WSGetInteger32Array() 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 an array of 32-bit integers from a link */

void f(WSLINK lp)
{
	int *data;
	int *dims;
	char **heads;
	int d;

	if(! WSGetInteger32Array(lp, &data, &dims, &heads, &d))
		{
			/* unable to read the array of integers from lp */
			return;
		}

	/* ... */

	WSReleaseInteger32Array(lp, data, dims, heads, d);
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[WSReleaseInteger32Array(), paclet:ref/c/WSReleaseInteger32Array])  ▪  (NonWLLink[WSGetInteger16Array(), paclet:ref/c/WSGetInteger16Array])  ▪  (NonWLLink[WSGetInteger64Array(), paclet:ref/c/WSGetInteger64Array])}})}})

({{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 Multidimensional Arrays, paclet:guide/WSTPCFunctionsForExchangingMultidimensionalArrays])}})}})