MLGetNumberAsUCS2String (C Function)

MLGetNumberAsUCS2String has been replaced by WSGetNumberAsUCS2String.

int MLGetNumberAsUCS2String(MLINK l, const unsigned short **s, int *n)

reads the next number on the MathLink connection specified by l as a string of UCS2 characters representing the number value stored in the string s of length n.

Details

  • MLGetNumberAsUCS2String() allocates memory to store the string value. To release the memory allocated by MLGetNumberAsUCS2String(), call MLReleaseUCS2String() on the contents of s. If MLGetNumberAsUCS2String() fails, do not call MLReleaseUCS2String() on the contents of s.
  • MLGetNumberAsUCS2String() returns 0 on error and a nonzero value on success.
  • MLGetNumberAsUCS2String() is declared in the MathLink header file mathlink.h.

Examples

Basic Examples  (1)

#include "mathlink.h"

/* A function for reading an integer from a link */

void f(MLINK l)
{
    switch(MLGetType(l))
    {
        case MLTKINT:
        {
            int rawType;
            rawType = MLGetRawType(l);
            if(rawType == MLTK_MLSHORT)
            {
                short theNumber;
                MLGetInteger16(l, &theNumber);
                /* ... */
            }
            else if(rawType == MLTK_MLINT)
            {
                int theNumber;
                MLGetInteger32(l, &theNumber);
                /* ... */
            }
            else
            {
                const unsigned short *theNumber;
                int length;
                MLGetNumberAsUCS2String(l, &theNumber, &length);
                /* ... */
                MLReleaseUCS2String(l, theNumber, length);
            }
        }
        break;
        case MLTKREAL:
            /* ... */
    }
}