WSPutMessageWithArg (C 関数)

int WSPutMessageWithArg(WSLINK link,int msg,int arg)

メッセージmsg とその引数arg をリンクオブジェクトlink に送信する.

詳細

  • WSTPメッセージは,通常のデータの転送に関連していない帯域外メッセージの送信・受信を行う.
  • WSPutMessageWithArg()はエラーがあると0を返し, 関数が成功すると0以外の値を返す.
  • WSError()を使うと,WSPutMessageWithArg()が不成功の場合にエラーコードを引き出すことができる.
  • WSPutMessageWithArg()は,WSTPヘッダファイルwstp.hの中で宣言される.

例題

  (1)

#include "wstp.h"


/* define some custom messages and arguments */

#define AppMenuMessage WSFirstUserMessage + 1

#define AppMenuOption1 1
#define AppMenuOption2 2

/* send an AppMenuMessage to a link */

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