MLPutByteString (C Function)

MLPutByteString has been replaced by WSPutByteString.

int MLPutByteString(MLINK link,const unsigned char *s,int n)

puts a string of n characters starting from location s to the MathLink connection specified by link.

Details

  • All characters in the string must be specified using character codes as obtained from ToCharacterCode in the Wolfram Language.
  • Newlines must thus be specified in terms of their raw character codes, rather than using n.
  • MLPutByteString() handles only characters with codes less than 256.
  • It can handle both ordinary ASCII as well as ISO Latin-1 characters.
  • MLPutByteString() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use MLError() to retrieve the error code if MLPutByteString() fails.
  • MLPutByteString() is declared in the MathLink header file mathlink.h.

Examples

Basic Examples  (1)

#include "mathlink.h"

/* transfer a string from a source link to a destination link */

void f(MLINK sourcelink, MLINK destinationlink)
{
    const unsigned char *string;
    int length;

    if(! MLGetByteString(sourcelink, &string, &length, 0))
        { /* unable to get the string from sourcelink */ }

    if(! MLPutByteString(destinationlink, string, length))
        { /* unable to put the string to destination link */ }
}