WSPutUCS2Symbol (C Function)

int WSPutUCS2Symbol(WSLINK link,const unsigned short *s,int len)

puts a symbol whose name is given by s with length len to the WSTP connection specified by link.


  • The symbol must be encoded in the UCS-2 character encoding scheme.
  • WSPutUCS2Symbol() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use WSError() to retrieve the error code if WSPutUCS2Symbol() fails.
  • WSPutUCS2Symbol() is declared in the WSTP header file wstp.h.


Basic Examples  (1)

#include "wstp.h"

/* send the symbol $Version to a link */

void f(WSLINK lp)
    unsigned short symb[8];

    symb[0] = '$';
    symb[1] = 'V';
    symb[2] = 'e';
    symb[3] = 'r';
    symb[4] = 's';
    symb[5] = 'i';
    symb[6] = 'o';
    symb[7] = 'n';

    if(! WSPutUCS2Symbol(lp, (const unsigned short *)symb, 8))
        { /* unable to send the symbol to lp */ }