WSTestSymbol （C 関数）

int WSTestSymbol(WSLINK l, const char *s)

l で指定されたWSTP接続上の次の式が値 s を持つ記号であることを検証する．

詳細

  • WSTestSymbol()は，リンク l 上の現行の式が記号ではない場合，あるいは記号の値が s にマッチしない場合には失敗する．
  • WSTestSymbol()は，エラーが起った場合には0を，関数が成功した場合には非零の値を返す．
  • WSTestSymbol()が失敗した場合には，WSError()を使ってエラーコードを得るとよい．
  • WSTestSymbol()は，関数が失敗した場合には，WSTestSymbol()を呼び出す直前のリンク上の式に対するストリームポインタを再設定する．この操作は，プログラマがWSCreateMark(link); WSTestSymbol(…); WSSeekToMark(…)を呼び出したかのように振舞う．
  • WSTestSymbol()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

/* A function for testing the next expression on the link for a symbol */

void f(WSLINK l)
{
    if(! WSTestSymbol(l, "List"))
    { /* The next expression on the link is not List */ }
    else
    { /* The next expression on the link is List */ }
}