WSGetInteger16List （C 関数）

int WSGetInteger16List(WSLINK link,short **a,int *n)

link で指定されたWSTP接続から16ビットの整数のリストを得て，その整数を配列 a に，そしてリストの長さを n に保持しておく．

詳細

  • WSGetInteger16List()は整数の配列にメモリを割り当てる．このメモリを開放するためにはWSReleaseInteger16List()を呼び出さなくてはならない．WSGetInteger16List()が不成功で関数の返す値がエラーを示している場合には，a のコンテンツについてWSReleaseInteger16List()を呼び出してはならない．
  • WSGetInteger16List()は不変のデータを返す．
  • WSGetInteger16List()はエラーがあると0を返し，関数が成功すると0以外の値を返す．
  • WSError()を使うと，WSGetInteger16List()が不成功の場合にエラーコードを引き出すことができる．
  • WSGetInteger16List()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

/* read a list of 16-bit integers from a link */

void f(WSLINK lp)
{
    short *data;
    int length;

    if(! WSGetInteger16List(lp, &data, &length))
        {
            /* unable to read the integer list from lp */
            return;
        }

    /* ... */

    WSReleaseInteger16List(lp, data, length);
}