WSTestUTF8String (C 関数)

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

l から読み込まれる次の式が値 s を持つ文字列であり,長さ n のUTF-8でコード化された文字列であることを検証する.

詳細

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

例題

  (1)

#include "wstp.h"

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

void f(WSLINK l)
{
    const unsigned char theString[8];

    theString[0] = '$'
    theString[1] = 'V';
    theString[2] = 'e';
    theString[3] = 'r';
    theString[4] = 's';
    theString[5] = 'i';
    theString[6] = 'o';
    theString[7] = 'n';

    if(! WSTestUTF8String(l, (const unsigned char *)theString,
        8))
    { /* The next expression on the link is not $Version */ }
    else
    { /* The next expression on the link is $Version */ }
}