WSUTF16ErrorMessage （C 関数）

const unsigned short * WSUTF16ErrorMessage(WSLINK l, int *n)

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

詳細

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

例題

例  (1)

#include "wstp.h"

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

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

    message = WSUCS2ErrorMessage(l, &length);

    /* We check for length <= 1 below because the string
    should contain a byte order mark */
    if(message == (const unsigned short *)0 || length <= 1)
    { /* Unable to read the error message */ }

    /* ... */

    WSReleaseUTF16ErrorMessage(l, message, length);
}