WSGetInteger32Array (C Function)
int WSGetInteger32Array(WSLINK link,int **a,int **dims,char ***heads,int *d)
gets an array of 32-bit integers from the WSTP connection specified by link, storing the array in a, its dimensions in dims and its depth in d.
Details
- The array a is laid out in memory like a C array declared as .
- 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 WSReleaseInteger32Array(). If WSGetInteger32Array() fails and the function's return value indicates an error, do not call 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 WSError() to retrieve the error code if WSGetInteger32Array() fails.
- WSGetInteger32Array() is declared in the WSTP header file wstp.h.
Examples
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);
}