MLGetUTF16Symbol (C 関数)

MLGetUTF16SymbolWSGetUTF16Symbolに置き換えられた.

int MLGetUTF16Symbol(MLINK link,const unsigned short **s,int *n,int *c)

link で指定されたMathLink接続から記号名に対応するUTF-16の文字列を得て,その文字列を s に,長さを n に,そして文字数を c に保持しておく.

詳細

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

例題

  (1)

#include "mathlink.h"

/* read a UTF-16 symbol from a link */

void f(MLINK lp)
{
    const unsigned short *symbol;
    int length;
    int characters;

    if(! MLGetUTF16Symbol(lp, &symbol, &length, &characters))
        {
            /* unable to read the UTF-16 symbol from lp */
            return;
        }

    /* ... */

    MLReleaseUTF16Symbol(lp, symbol, length, characters);
}