WSGetUTF32Function (C Function)

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

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

Details

  • WSGetUTF32Function() allocates memory for the character string corresponding to the name of the head of the function. You must call WSReleaseUTF32Symbol() to disown this memory. If WSGetUTF32Function() fails and the function's return value indicates an error, do not call WSReleaseUTF32Symbol() on the contents of s.
  • Programs should not modify the contents of the character string s.
  • The character string returned by WSGetUTF32Function() begins with a platform-appropriate byte order mark. The byte order mark is included in the length of the symbol v.
  • WSGetUTF32Function(l, &s, &v, &n) has the same effect as WSGetNext(l); WSGetArgCount(l, &n); WSGetUTF32Symbol(l, &s, &v).
  • WSGetUTF32Function() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use WSError() to retrieve the error code if WSGetUTF32Function() fails.
  • WSGetUTF32Function() 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 int *s;
    int length;
    int n;

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

    /* ... */

    WSReleaseUTF32Function(l, s, length);
}