WSGetUTF16Function （C 関数）

int WSGetUTF16Function( WSLINK l , const unsigned short * s , int * v , int * n )

l が指定するWSTP接続からのUTF-16のコード化形式でコード化された頭部として，記号を含む関数を得て，記号の名前を s に，UTF-16コードの長さを v に，関数の引数の数を n に保存する．

詳細

  • WSGetUTF16Function()は，関数の頭部の名前に対応する文字列にメモリを割り当てる．このメモリを解放するためには，WSReleaseUTF16Symbol()を呼び出さなければならない．WSGetUTF16Function()が失敗し，関数の戻り値がエラーを示す場合には，s の内容に対してWSReleaseUTF16Symbol()を呼び出してはならない．
  • プログラムは，文字列 s の内容を変更してはならない．
  • WSGetUTF16Function()によって返された文字列は，プラットフォームに適切なバイトオーダーマークで始まる．このバイトオーダーマークは，長さの値 v に含まれる．
  • WSGetUTF16Function(l, &s, &v, &n)は，WSGetNext(l); WSGetArgCount(l, &n); WSGetUTF16Symbol(l, &s, &v, &c)と同じ効果がある．その場合，c は s でコード化されている文字の数である．
  • WSGetUTF16Function()は，エラーがあった場合には0を返し，関数が成功した場合には非零の値を返す．
  • WSGetUTF16Function()が失敗した場合には，WSError()を使ってエラーコードを得るとよい．
  • WSGetUTF16Function()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

/* read a function from a link */

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

    if(! WSGetUTF16Function(l, &s, &length, &n))
    { /* Unable to read the function from the link */ }

    /* ... */

    WSReleaseUTF16Symbol(l, s, length);
}