WSTestUTF32Head (C Function)

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

tests that the next expression to be read from l is an expression with the head h, a UTF-32 encoded name of length v, and stores the number of arguments of the expression in n.


  • WSTestUTF32Head() fails if the current expression on the link is not a function with a symbol as a head, or if the name of the symbol does not match h.
  • WSTestUTF32Head() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use WSError() to retrieve the error code if WSTestUTF32Head() fails.
  • WSTestUTF32Head() will reset the stream pointer to the expression on the link just prior to calling WSTestUTF32Head() if the function fails. This operation behaves as if the programmer called WSCreateMark(l); WSTestUTF32Head(); WSSeekToMark().
  • The UTF-32 encoded head h must include a byte order mark.
  • The length v of the UTF-32 encoded head h must include the byte order mark.
  • WSTestUTF32Head() is declared in the WSTP header file wstp.h.


Basic Examples  (1)

#include "wstp.h"

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

void f(WSLINK l)
    const unsigned int packet[13];
    int arguments;

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

    if(! WSTestUTF32Head(l, (const unsigned short *)packet, 13,
    { /* read the contents of the ReturnPacket[] */ }
    { /* the head of the incoming expression is not ReturnPacket */ }