WSTestUTF8Symbol （C 関数）

int WSTestUTF8Symbol(WSLINK l, const unsigned char *s, int n)

l で指定されたWSTP接続上の次の式が値 s を持つ記号であり，長さ n のUTF-8でコード化された文字列であることを検証する．

詳細

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

例題

例  (1)

#include "wstp.h"

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

void f(WSLINK l)
{
    const unsigned char theSymbol[5];

    theSymbol[0] = 'L';
    theSymbol[1] = 'i';
    theSymbol[2] = 's';
    theSymbol[3] = 't';

    if(! WSTestUTF8Symbol(l, (const unsigned char *)theSymbol,
        4))
    { /* The next expression on the link is not List */ }
    else
    { /* The next expression on the link is List */ }
}