WSUTF8LinkName （C 関数）

const unsigned char * WSUTF8LinkName(WSLINK l, int *n)

l で指定されたWSTP接続の名前を表す，UTF-8のコード形式でコード化された長さ n の文字列を返す．

詳細

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

例題

例  (1)

#include "wstp.h"

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

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

    name = WSUTF8LinkName(l, &length);

    if(name == (const unsigned char *)0 || length == 0)
    { /* Unable to get the name of the link */ }

    /* ... */

    WSReleaseUTF8LinkName(l, name, length);
}