WSGetUTF16String （C 関数）

int WSGetUTF16String(WSLINK link,const unsigned short **s,int *n,int *c)

link で指定されたWSTP接続からUTF-16の文字列を得て，その文字列を s に，文字列の長さを n に，そして文字数を c に保持しておく．

詳細

  • WSGetUTF16String()は文字列にメモリを割り当てる．このメモリを解放するためにはWSReleaseUTF16String()を呼び出さなくてはならない．WSGetUTF16String()が不成功で関数の返す値がエラーを示す場合には，s のコンテンツについてWSReleaseUTF16String()を呼び出してはならない．
  • WSGetUTF16String()は不変のデータを返す．
  • WSGetUTF16String()はすべての文字を直接UTF-16 Unicodeのコード化形式で保持する．
  • WSGetUTF16String()で返された文字列 s は，バイトオーダーマークで始まる．
  • 文字列の長さ n には，バイトオーダーマークが含まれる．
  • WSGetUTF16String()はエラーがあると0を返し，関数が成功すると0以外の値を返す．
  • WSError()を使うと，WSGetUTF16String()が不成功の場合にエラーコードを引き出すことができる．
  • WSGetUTF16String()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

/* read a UTF-16 encoded string from a link */

void f(WSLINK lp)
{
    const unsigned short *string;
    int length;
    int characters;

    if(! WSGetUTF16String(lp, &string, &length, &characters))
        {
            /* unable to read the UTF-16 string from lp */
            return;
        }

    /* ... */

    WSReleaseUTF16String(lp, string, length);
}