WSTestUTF16Head (C Function)

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

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

Details

  • WSTestUTF16Head() 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.
  • WSTestUTF16Head() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use WSError() to retrieve the error code if WSTestUTF16Head() fails.
  • WSTestUTF16Head() will reset the stream pointer to the expression on the link just prior to calling WSTestUTF16Head() if the function fails. This operation behaves as if the programmer called WSCreateMark(l); WSTestUTF16Head(…); WSSeekToMark(…).
  • The UTF-16 encoded head h must include a byte order mark.
  • The length v of the UTF-16 encoded head h must include the byte order mark.
  • WSTestUTF16Head() is declared in the WSTP header file wstp.h.

Examples

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 short 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(! WSTestUCS2Head(l, (const unsigned short *)packet, 13,
        &arguments))
    { /* read the contents of the ReturnPacket[] */ }
    else
    { /* the head of the incoming expression is not ReturnPacket */ }
}