WSGetSymbol （C 関数）

int WSGetSymbol(WSLINK link,const char **s)

link で指定されたWSTP接続から記号名に対応する文字列を得て，結果として得た文字列を s に保持しておく．

詳細

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

例題

例  (1)

#include "wstp.h"

/* read a symbol from a link */

void f(WSLINK lp)
{
    const char *symbol;

    if(! WSGetSymbol(lp, &symbol))
        {
            /* unable to read the symbol from lp */
            return;
        }

    /* ... */

    WSReleaseSymbol(lp, symbol);
}