WSUTF16LinkName （C 関数）

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

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

詳細

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

例題

例  (1)

#include "wstp.h"

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

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

    name = WSUTF16LinkName(l, &length);

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

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

    /* ... */

    WSReleaseUTF16LinkName(l, name, length);
}