WSTestUTF8Head （C 関数）

int WSTestUTF8Head(WSLINK l, const unsigned char *h, int v, int *n)

l から読み込まれる次の式が頭部 h を持つ式と長さ v のUTF-8でコード化された名前であり，式の引数の数を n に保存することを検証する．

詳細

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

例題

例  (1)

#include "wstp.h"

/* A function for testing whether the next expression on the link is a ReturnPacket[] */

void f(WSLINK l)
{
    const unsigned char packet[12];
    int arguments;

    packet[0] =  'R';
    packet[1] =  'e';
    packet[2] =  't';
    packet[3] =  'u';
    packet[4] =  'r';
    packet[5] =  'n';
    packet[6] =  'P';
    packet[7] =  'a';
    packet[8] =  'c';
    packet[9] =  'k';
    packet[10] = 'e';
    packet[11] = 't';

    if(! WSTestUTF8Head(l, (const unsigned short *)packet, 12,
        &arguments))
    { /* read the contents of the ReturnPacket[] */ }
    else
    { /* the head of the incoming expression is not ReturnPacket */ }
}