WSUCS2LinkName （C 関数）

const unsigned short * WSUCS2LinkName(WSLINK l, int *n)

l で指定されたWSTP接続から，長さ n のUCS2でコード化された文字列としてコード化されたリンクの名前を返す．

詳細

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

例題

例  (1)

#include "wstp.h"

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

void f(WSLINK l)
{
    const unsigned short *name;
    int length;

    name = WSUCS2LinkName(l, &length);
    if(name == NULL || length == 0)
    { /* Unable to read link name */ }

    /* ... */

    WSReleaseUCS2LinkName(l, name, length);
}