MLGetByteString (C 関数)

MLGetByteStringWSGetByteStringに置き換えられた.

int MLGetByteString(MLINK link,const unsigned char **s,int *n,long spec)

link で指定されたMathLink接続から文字列を得て,文字のコードを s に,そして文字数を n に保持しておく. コード spec は Wolframシステム上の文字コードが255より大きい任意の文字に使われる.

詳細

  • MLGetByteString()は文字コードの配列にメモリを割り当てる.このメモリを開放するためには, MLReleaseByteString()を呼び出さなければならない.MLGetByteString()が不成功で関数の返す値がエラーを示している場合には,s に含まれている値についてMLReleaseByteString()を呼び出してはならない.
  • MLGetByteString()は特殊文字が現れない状況では便利である.
  • MLGetByteString()で使用される文字コードは,Wolframシステム内でToCharacterCodeが返すコードと同一である.
  • MLGetByteString()の文字コード配列は,空白文字で終らない.
  • 改行のような文字は,n等のASCII形式ではなく,原始文字コードで特定される.
  • MLGetByteString()は不変のデータを返す.
  • MLGetByteString()はエラーがあると0を返し,関数が成功すると0以外の値を返す.
  • MLError()を使うと,MLGetByteString()が不成功の場合にエラーコードを引き出すことができる.
  • MLGetByteString()は,MathLinkヘッダファイルmathlink.hの中で宣言される.

例題

  (1)

#include "mathlink.h"

/* read a string encoded with codes from ToCharacterCode[] from a link */

void f(MLINK lp)
{
    const unsigned char *string;
    int length;

    if(! MLGetByteString(lp, &string, &length, 0))
        {
            /* unable to read the byte string from lp */
            return;
        }

    /* ... */

    MLReleaseByteString(lp, string, length);
}