WSGetUTF8Function (C Function)

int WSGetUTF8Function( WSLINK l , const unsigned char ** s , int * v , int * n )

gets a function with a symbol as a head encoded in the UTF-8 encoding form from the WSTP connection specified by l, storing the name of the symbol in s, the length of the UTF-8 codes in v, and the number of arguments of the function in n.

Details

  • WSGetUTF8Function() allocates memory for the character string corresponding to the name of the head of the function. You must call WSReleaseUTF8Symbol() to disown this memory. If WSGetUTF8Function() fails and the function's return value indicates an error, do not call WSReleaseUTF8Symbol() on the contents of s.
  • Programs should not modify the contents of the character string s.
  • WSGetUTF8Function(l, &s, &v, &n) has the same effect as WSGetNext(l); WSGetArgCount(l, &n); WSGetUTF8Symbol(l, &s, &v, &c), where c is the number of characters encoded in s.
  • WSGetUTF8Function() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use WSError() to retrieve the error code if WSGetUTF8Function() fails.
  • WSGetUTF8Function() is declared in the WSTP header file wstp.h.

Examples

Basic Examples  (1)

#include "wstp.h"

/* read a function from a link */

void f(WSLINK l)
{
    unsigned char *s;
    int length;
    int n;

    if(! WSGetUTF8Function(l, &s, &length, &n))
    { /* Unable to read the function from the link */ }

    /* ... */

    WSReleaseUTF8Symbol(l, s, length);
}