OpenersNotesSection(Spacer1)Details

The array a is laid out in memory like a C array declared as short 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.

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

External programs should not modify the arrays generated by MLGetInteger16Array().

MLGetInteger16Array() returns immutable data.

MLGetInteger16Array() returns 0 in the event of an error, and a nonzero value if the function succeeds.

Use (NonWLLink[MLError(), paclet:ref/c/MLError]) to retrieve the error code if MLGetInteger16Array() fails.

MLGetInteger16Array() is declared in the MathLink header file (RefLink[mathlink.h, paclet:ref/file/mathlink.h]).

OpenersPrimaryExamplesSection(Spacer1)Examples  (1)

OpenersExampleSection0(Spacer1)Basic Examples  (1)

#include "mathlink.h"

/* read an array of 16-bit integers from a link */

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

	if(! MLGetInteger16Array(lp, &data, &dims, &heads, &d))
		{
			/* unable to read the integer array */
			return;
		}

	/* ... */

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

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[MLReleaseInteger16Array(), paclet:ref/c/MLReleaseInteger16Array])  ▪  (NonWLLink[MLGetInteger32Array(), paclet:ref/c/MLGetInteger32Array])  ▪  (NonWLLink[MLGetInteger64Array(), paclet:ref/c/MLGetInteger64Array])}})}})

({{DocumentationFooterIconsRelatedTutorial.png, ({{Tutorials}, {▪(RefLinkPlain[Manipulating Expressions in External Programs, paclet:tutorial/ManipulatingExpressionsInExternalPrograms])}, {▪(RefLinkPlain[Handling Lists, Arrays and Other Expressions, paclet:tutorial/HandlingListsArraysAndOtherExpressions])}})}})