WSUTF32LinkName （C 関数）

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

詳細

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

例題

例  (1)

#include "wstp.h"

/* A function for getting the name of a link */

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

    name = WSUTF32LinkName(l, &length);

    /* We check for length <= 1 because WSUTF32LinkName returns a
    string with a byte order mark. */

    if(name == (const unsigned int *)0 || length <= 1)
    { /* Unable to read the name of the link */ }

    /* ... */

    WSReleaseUTF32LinkName(l, name, length);
}