WSUTF8ErrorMessage （C 関数）

const unsigned char * WSUTF8ErrorMessage(WSLINK l, int *n)

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

詳細

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

例題

例  (1)

#include "wstp.h"

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

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

    message = WSUTF8ErrorMessage(l, &length);

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

    /* ... */

    WSReleaseUTF8ErrorMessage(l, message, length);
}