MLUTF32LinkName (C Function)

MLUTF32LinkName has been replaced by WSUTF32LinkName.

returns a string of length n encoded in the UTF-32 encoding form representing the name string used to create the MathLink connection specified by l.

Details

  • MLUTF32LinkName() allocates memory for the link name that must be released. To release the memory, call MLReleaseUTF32LinkName() on the value returned by the function. If MLUTF32LinkName() returns NULL, do not call MLReleaseUTF32LinkName() on the NULL value.
  • Programs should not modify the contents of the string returned by MLUTF32LinkName().
  • MLUTF32LinkName() returns a string with a platform-appropriate byte order mark.
  • The length of the string n includes the byte order mark.
  • MathLink links are created using a combination of link mode, link protocol, and other options. The link name provides necessary information for the link mode and link protocol used to create the link.
  • MLUTF32LinkName() is declared in the MathLink header file mathlink.h.

Examples

Basic Examples  (1)

#include "mathlink.h"

/* A function for getting the name of a link */

void f(MLINK l)
{
    const unsigned int *name;
    int length;

    name = MLUTF32LinkName(l, &length);

    /* We check for length <= 1 because MLUTF32LinkName returns a
    string with a byte order mark. */

    if(name == (const unsigned int *)0 || length <= 1)
    { /* Unable to read the name of the link */ }

    /* ... */

    MLReleaseUTF32LinkName(l, name, length);
}