MLPutMessageWithArg (C Function)

MLPutMessageWithArg has been replaced by WSPutMessageWithArg.

int MLPutMessageWithArg(MLINK link,int msg,int arg)

sends the message msg and its argument arg to the link object link.

Details

  • MathLink messages provide out-of-band message sending and receiving that is not tied to the normal transfer of data.
  • MLPutMessageWithArg() returns 0 in the event of an error, and a nonzero value if the function succeeds.
  • Use MLError() to retrieve the error code if MLPutMessageWithArg() fails.
  • MLPutMessageWithArg() is declared in the MathLink header file mathlink.h.

Examples

Basic Examples  (1)

#include "mathlink.h"


/* define some custom messages and arguments */

#define AppMenuMessage MLFirstUserMessage + 1

#define AppMenuOption1 1
#define AppMenuOption2 2

/* send an AppMenuMessage to a link */

void f(MLINK lp)
{
    if(! MLPutMessageWithArg(lp, AppMenuMessage, AppMenuOption2))
        { /* unable to send the message to lp */ }
}