WSTestUTF16Symbol (C 関数)

int WSTestUTF16Symbol(WSLINK l, const unsigned short *s, int n)

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

詳細

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

例題

  (1)

#include "wstp.h"

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

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

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

    if(! WSTestUTF16Symbol(l, (const unsigned short *)theSymbol,
        5))
    { /* The next expression on the link is not List */ }
    else
    { /* The next expression on the link is List */ }
}