WSLinkName （C 関数）

const char * WSLinkName(WSLINK link)

リンクを作成するために使った名前の文字列を返す．

詳細

  • WSLinkName()は，解放されなければならないリンク名にメモリを割り当てる．メモリを解放する場合には，関数によって返された値に対してWSReleaseLinkName()を呼び出す．WSLinkName()がNULLを返す場合には，NULLの値に対してWSReleaseLinkName()を呼び出してはならない．
  • プログラムは，WSLinkName()が返す文字列の内容を変更してはならない．
  • WSTPのリンクは，リンクモード，リンクプロトコル，その他のオプション等を組み合わせて作成される．リンク名は，リンクモードやリンクを作成するのに使ったリンクプロトコルに必要な情報を提供する．
  • WSLinkName()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (3)

LinkLaunchを使って開いたリンクは，リンク名として実行される完全なコマンドラインを使用する：

完全なリンク名は，LinkObjectの第1要素として保存される：

LinkCreateを使って開いたリンクは，プロトコル依存の名前を持ち，接続情報を含む：

デフォルトの"SharedMemory"プロトコルは，共有のメモリオブジェクトの名前を使う：

const char * 変数を宣言してリンク名を得る：

#include "wstp.h"

/* A function for reading a link's name */

void f(WSLINK lp)
{
    const char *name;

    name = WSLinkName(lp);
    if(name == (const char *)0)
    { /* Unable to get the link name */ }

    /* ... */

    WSReleaseLinkName(lp, name);
}