WSGetUCS2Symbol （C 関数）

int WSGetUCS2Symbol(WSLINK link,const unsigned short **s,int *len)

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

詳細

  • WSGetUCS2Symbol()は文字列にメモリを割り当てる．このメモリを解放するためにはWSReleaseUCS2Symbol()を呼び出さなくてはならない．WSGetUCS2Symbol()が不成功で関数の返す値がエラーを示す場合には，s のコンテンツについてWSReleaseUCS2Symbol()を呼び出してはならない．
  • WSGetUCS2Symbol()はで終了する文字列を作成する．
  • WSGetUCS2Symbol()はエラーがあると0を返し，関数が成功すると0以外の値を返す．
  • WSError()を使うと，WSGetUCS2Symbol()が不成功の場合にエラーコードを引き出すことができる．
  • WSGetUCS2Symbol()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

/* read a UCS-2 encoded symbol from a link */

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

    if(! WSGetUCS2Symbol(lp, &symbol, &len))
        {
            /* unable to retrieve the UCS-2 symbol */
            return;
        }

    /* ... */

    WSReleaseUCS2Symbol(lp, symbol, len);
}