WSGetUTF32Symbol （C 関数）

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

link で指定されたWSTP接続から記号名に対応するUTF-32の文字列を得て，その結果できた文字列を s に，そしてその長さを len に保持しておく．

詳細

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

例題

例  (1)

#include "wstp.h"

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

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

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

    /* ... */

    WSReleaseUTF32Symbol(lp, symbol, len);
}