MLGetLinksFromEnvironment (C Function)

MLGetLinksFromEnvironment has been replaced by WSGetLinksFromEnvironment.

int MLGetLinksFromEnvironment( MLENV env , MLINK ** links , int * l )

gets the list of currently open links in the MathLink environment env, and stores the list in links and the list length in l.

Details

  • MLGetLinksFromEnvironment() allocates memory to store the list of links that must be released by calling MLReleaseLinksFromEnvironment(). If MLGetLinksFromEnvironment() returns an error, do not call MLReleaseLinksFromEnvironment() on the contents of links.
  • MLGetLinksFromEnvironment() returns 1 on success and 0 on failure.
  • MLGetLinksFromEnvironment() is declared in the MathLink header file mathlink.h.

Examples

Basic Examples  (1)

#include "mathlink.h"

void examineTheLinks(MLENV env)
{
    MLINK *theLinks;
    int length;
    int apiResult;

    apiResult = MLGetLinksFromEnvironment(env, &theLinks, &length);
    if(! apiResult)
    { /* Unable to retrieve the list of open links */ }

    /* ... */

    MLReleaseLinksFromEnvironment(env, theLinks, length);
}