WSSetEnvIDString （C 関数）

int WSSetEnvIDString(WSENV env,const char *eid)

WSTP環境の識別文字列を eid に設定する．

詳細

  • 任意のパケットデータを送信する前に，リンクの向こう側に識別の形を提供したほうがよいこともある．WSSetEnvIDString()がアプリケーションの識別文字列を設定し，WSTPはその文字列をWSActivate()の時間中に任意のリモートWSTP接続と交換する．
  • WSSetEnvIDString()はエラーがあると0を返し，関数が成功すると0以外の値を返す．
  • WSSetEnvIDString()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

int main()
{
    WSENV env;

    env = WSInitialize((WSEnvironmentParameter)0);
    if(env == (WSENV)0)
        { /* unable to initialize the WSTP environment */ }

    if(! WSSetEnvIDString(env, "Your Company Inc. App 25"))
        { /* unable to set app ID string */ }

    /* ... */    

    WSDeinitialize(env);
    return 0;
}