MLSetYieldFunction （C 関数）

MLSetYieldFunctionはWSSetYieldFunctionに置き換えられた．

int MLSetYieldFunction(MLINK link,MLYieldFunctionObject yf)

降伏関数 yf を link で参照されるリンクのためにインストールする．

詳細

  • MathLink APIの呼出しは，データが読取りに使えるようになるか，あるいは書込みに必要な容量ができるようになるまで，阻止されることがある．その阻止時間中にアプリケーションで他の有用な処理を行う必要がある場合は，そのアプリケーションにリンクのための降伏関数をインストールすれば，MathLinkが自動的に阻止時間中に降伏関数の呼出しを行うようになる．
  • 阻止された読取りや書込みを取り消すためには，降伏関数はゼロ以外の値を返すべきである．
  • MLSetYieldFunction()はエラーがあると0を返し，関数が成功するとゼロ以外の値を返す．
  • Windowsでは，MLYieldFunctionObjectはWINAPI呼出し規則を使う．
  • MLError()を使うと，MLSetYieldFunction()が不成功の場合にエラーコードを引き出すことができる．
  • MLSetYieldFunction()は，MathLinkヘッダファイルmathlink.hの中で宣言される．

例題

例  (1)

#include "mathlink.h"

#if UNIX_MATHLINK
#    define CALLING_CONVENTION
#elif WINDOWS_MATHLINK
#    define CALLING_CONVENTION WINAPI
#endif

int CALLING_CONVENTION AppYieldFunction(MLINK lp, MLYieldParameters yp)
{
    /* ... */
    return 0;
}

int main(int argc, char **argv)
{
    MLENV env;
    MLINK link;
    int error;

    env = MLInitialize((MLEnvironmentParameter)0);
    if(env == (MLENV)0)
        { /* unable to initialize MathLink environment */ }

    link = MLOpenArgcArgv(env, argv, argv + argc, &error);
    if(link == (MLINK)0 || error != MLEOK)
        { /* unable to create the link */ }

    if(! MLSetYieldFunction(link, AppYieldFunction))
        { /* unable to set the yield function for link */ }

    /* ... */

    MLClose(link);
    MLDeinitialize(env);
    return 0;
}