WSGetInteger16Array （C 関数）

int WSGetInteger16Array(WSLINK link,short **a,int **dims,char ***heads,int *d)

link で指定されたWSTP接続から16ビットの整数の配列を得て，配列を a に，その次元を dims に，そしてその深さを d に保持しておく．

詳細

  • 配列 a は と宣言されたC言語の配列のようにメモリにレイアウトされる．
  • heads は，配列の各レベルに頭部として現れる記号名に対応する文字列のリストを返す．
  • WSGetInteger16Array()は，WSReleaseInteger16Array()を呼び出して解放しなければならないメモリを割り当てる．WSGetInteger16Array()が不成功で関数の返す値がエラーを示している場合には，a のコンテンツについてWSReleaseInteger16Array()を呼び出してはならない．
  • WSGetInteger16Array()が生成した配列を外部プログラムで変更してはならない．
  • WSGetInteger16Array()は不変のデータを返す．
  • WSGetInteger16Array()はエラーがあると0を返し，関数が成功すると0以外の値を返す．
  • WSError()を使うと，WSGetInteger16Array()が不成功の場合にエラーコードを引き出すことができる．
  • WSGetInteger16Array()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

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

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

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

    /* ... */

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