WSPutRealNumberAsUTF16String (C Function)

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

sends a floating-point number encoded as UTF-16 string s of length n to the WSTP connection specified by l.

Details

  • Send the number s in the form "3.14159".
  • The number s encoded in UTF-16 must begin with a byte order mark.
  • The length of the string n must include the byte order mark.
  • WSPutRealNumberAsUTF16String() returns 0 on error, and a nonzero value if the function succeeds.
  • WSPutRealNumberAsUTF16String() is declared in the WSTP header file wstp.h.

Examples

Basic Examples  (1)

#include "wstp.h"

/* A function to put the expression Sqrt[2.75] to a link */

void f(WSLINK l)
{
    unsigned short theNumber[5];

    theNumber[0] = 0xFEFF;
    theNumber[1] = '2';
    theNumber[2] = '.';
    theNumber[3] = '7';
    theNumber[4] = '5';

    if(! WSPutFunction(l, "Sqrt", 1))
    { /* Unable to put Sqrt[] to the link */ }

    if(! WSPutRealNumberAsUTF16String(l, theNumber, 5))
    { /* Unable to put the number to the link */}

    if(! WSEndPacket(l))
    { /* Unable to put the end-of-packet sequence to l */ }

    if(! WSFlush(l))
    { /* Unable to flush any output buffered in l */ }
}