MLGetInteger64Array (C Function)

MLGetInteger64Array has been replaced by WSGetInteger64Array.

int MLGetInteger64Array(MLINK link,mlint64 **a,int **dims,char ***heads,int *d)

gets an array of native 64-bit integers from the MathLink 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 mlint64 .
  • heads gives a list of character strings corresponding to the names of symbols that appear as heads at each level in the array.
  • MLGetInteger64Array() allocates memory which must be disowned by calling MLReleaseInteger64Array(). If MLGetInteger64Array() fails and the function's return value indicates an error, do not call MLReleaseInteger64Array() on the contents of a.
  • MLGetInteger64Array() returns immutable data.
  • MLGetInteger64Array() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use MLError() to retrieve the error code if MLGetInteger64Array() fails.
  • MLGetInteger64Array() is declared in the MathLink header file mathlink.h.

Examples

Basic Examples  (1)

#include "mathlink.h"

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

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

    if(! MLGetInteger64Array(lp, &data, &dims, &heads, &d))
        {
            /* unable to get the array of 64-bit integers from lp */
            return;
        }

    /* ... */

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