WSGetString （C 関数）

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

link で指定されたWSTP接続から文字列を得て，その文字列を s に保持しておく．

詳細

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

例題

例  (1)

#include "wstp.h"

/* read a string from a link */

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

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

    /* ... */

    WSReleaseString(lp, string);
}