WSGetIntegerList （C 関数）

int WSGetIntegerList(WSLINK link,int **a,long *n)

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

詳細

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

例題

例  (1)

#include "wstp.h"

/* read a list of integers from a link */

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

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

    /* ... */

    WSDisownIntegerList(lp, data, length);
}