DOCUMENTATION CENTER SEARCH
Mathematica > Systems Interfaces & Deployment > C/C++ Language Interface > MathLink C Language Functions >
Mathematica > Systems Interfaces & Deployment > MathLink API > MathLink C Language Functions >
MathLink C Function

MLGetInteger16Array()

int MLGetInteger16Array(MLINK link, short **a, int **dims, char ***heads, int *d)
gets an array of 16-bit integers from the MathLink connection specified by link, storing the array in a, its dimensions in dims and its depth in d.
  • 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.
  • 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 MLError() to retrieve the error code if MLGetInteger16Array() fails.
  • MLGetInteger16Array() is declared in the MathLink header file mathlink.h.
EXAMPLESCLOSE ALL
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);
}
© 2008 Wolfram Research, Inc.
Ask a question about this page  |  Suggest an improvement  |  Leave a message for the team