WSGetUCS2String （C 関数）

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

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

詳細

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

例題

例  (1)

#include "wstp.h"

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

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

    if(! WSGetUCS2String(lp, &string, &length))
        {
            /* unable to read the UCS-2 string */
            return;
        }

    /* ... */

    WSReleaseUCS2String(lp, string, length);
}