WSGetUTF8Symbol （C 関数）

int WSGetUTF8Symbol(WSLINK link,const unsigned char **s,int *b,int *c)

link で指定されたWSTP接続から記号名に対応するUTF-8でコード化された文字列を得て，その結果を s に，文字列内のバイト数を b に，そして文字列内の文字数を c に保持しておく．

詳細

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

例題

例  (1)

#include "wstp.h"

/* read an UTF-8 encoded symbol from a link */

void f(WSLINK lp)
{
    const unsigned char *symbol;
    int bytes;
    int characters;

    if(! WSGetUTF8Symbol(lp, &symbol, &bytes, &characters))
        {
            /* unable to read the UTF-8 symbol from lp */
            return;
        }

    /* ... */

    WSReleaseUTF8Symbol(lp, symbol, bytes);
}