WSGetFunction （C 関数）

int WSGetFunction(WSLINK link,const char **s,int *n)

link で指定されたWSTP接続から記号を頭部として持つ関数を得て，その記号名を s に，そして関数の引数の数を n に保持しておく．

詳細

  • WSGetFunction()は関数の頭部の名前に対応する文字列にメモリを割り当てる． このメモリを開放するためには，WSReleaseSymbol()を呼び出さなければならない．WSGetFunction()が不成功で関数の返す値がエラーを示している場合には，s の内容についてWSReleaseSymbol()を呼び出してはならない．
  • 外部プログラムで文字列s を変更してはならない．
  • は，WSGetNext(link);WSGetArgCount(link,&n);WSGetSymbol(link,&s)と同じ働きをする．
  • WSGetFunction()はエラーがあると0を返し，関数が成功すると0以外の値を返す．
  • WSError()を使うと，WSGetFunction()が不成功の場合にエラーコードを引き出すことができる．
  • WSGetFunction()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

/* read a function from a link */

void f(WSLINK lp)
{
    const char *f;
    int n;

    if(! WSGetFunction(lp, &f, &n))
        {
            /* unable to read the function from lp */
            return;
        }

    /* ... */

    WSReleaseSymbol(lp, f);
}