WSGetUTF32String （C 関数）

int WSGetUTF32String(WSLINK link,const unsigned int **s,int *len)

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

詳細

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

例題

例  (1)

#include "wstp.h"

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

void f(WSLINK lp)
{
    const unsigned int *string;
    int len;

    if(! WSGetUTF32String(lp, &string, &len))
        {
            /* unable to read the UTF-32 string from lp */
            return;
        }

    /* ... */

    WSReleaseUTF32String(lp, string, len);
}