WSUTF32ErrorMessage （C 関数）

const unsigned int * WSUTF32ErrorMessage(WSLINK l, int *n)

l で指定されたWSTP接続上で最後に起ったエラーを説明する，長さ n のUTF-32のコード形式でコード化された文字列を返す．

詳細

  • WSUTF32ErrorMessage()は，解放しなければならないメッセージについてメモリを割り当てる．WSReleaseUTF32ErrorMessage()を使って，WSUTF32ErrorMessage()によって割り当てられたメモリを解放する．WSUTF32ErrorMessage()がNULLを返す場合には，NULLの値についてWSReleaseUTF32ErrorMessage()を呼び出してはならない．
  • プログラムは，エラーメッセージの文字列の内容を変更してはならない．
  • WSUTF32ErrorMessage()によって返される文字列には，プラットフォームに適したバイトオーダーマークが含まれていなければならない．
  • 文字列 n の長さには，バイトオーダーマークが含まれる．
  • WSUTF32ErrorMessage()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

/* A function for reading the error message from a link */

void f(WSLINK l)
{
    const unsigned int *message;
    int length;

    message = WSUTF32ErrorMessage(l, &length);

    /* We check for length <= 1 because WSUTF32ErrorMessage() returns
    a byte order mark. */

    if(message == (const unsigned int *)0 || length <= 1)
    { /* Unable to read the error message from the link */ }

    /* ... */

    WSReleaseUTF32ErrorMessage(l, message, length);
}