WSGetByteArray （C 関数）

int WSGetByteArray(WSLINK link,unsigned char **a,int **dims,char ***heads,int *d)

link で指定されたWSTP接続から1バイトサイズの整数配列を得て，配列を a，次元を dims，深さを d に保持しておく．　

詳細

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

例題

例  (1)

#include "wstp.h"

/* read a byte-sized integer array from a link */

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

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

    /* ... */

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