WSTestUCS2HeadWithArgCount (C Function)

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

tests that the next object to be read from the WSTP connection specified by l is an expression with head s, an UCS-2 encoded character string of length v, and that the number of arguments of the expression is n.


  • WSTestUCS2HeadWithArgCount() fails if the current expression on the link is not a function with a symbol as a head, if the name of the symbol does not match s, or if the number of arguments for the function is not n.
  • WSTestUCS2HeadWithArgCount() stores the actual number of arguments to the function in n when the function returns.
  • WSTestUCS2HeadWithArgCount() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use WSError() to retrieve the error code if WSTestUCS2HeadWithArgCount() fails.
  • WSTestUCS2HeadWithArgCount() will reset the stream pointer to the expression on the link just prior to calling WSTestUCS2HeadWithArgCount() if the function fails. This operation behaves as if the programmer has called WSCreateMark(l); WSTestUCS2HeadWithArgCount(...); WSSeekToMark(...).
  • WSTestUCS2HeadWithArgCount() is declared in the WSTP header file wstp.h.


Basic Examples  (1)

#include "wstp.h"

/* A function to test whether the next expression on the Link is Plus[a,b] */

void f(WSLINK l)
    unsigned short symbol[4];
    int args = 2;
    const char *symbol;

    symbol[0] = 'P';
    symbol[1] = 'l';
    symbol[2] = 'u';
    symbol[3] = 's';

    if(! WSTestUCS2HeadWithArgCount(l, (const unsigned short *)symbol, 4, &args))
    { /* Next expression is not Plus, or does not have two args */ }

    if(! WSGetSymbol(l, &symbol))
    { /* Unable to read symbol */ }

    /* Check if symbol is 'a' */

    WSReleaseSymbol(l, symbol);

    if(! WSGetSymbol(l, &symbol))
    { /* Unable to read symbol */ }

    /* Check if the symbol is 'b' */

    WSReleaseSymbol(l, symbol);