WSGetUnicodeString （C 関数）

int WSGetUnicodeString(WSLINK link,unsigned short **s,long *n)

link で指定されたWSTP接続から文字列を得て，その文字列を s に16ビットのUnicode文字列として保持しておく．

詳細

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

例題

例  (1)

#include "wstp.h"

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

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

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

    /* ... */

    WSDisownUnicodeString(lp, string, length);
}