WSGetInteger16 (C 関数)

int WSGetInteger16(WSLINK link,short *i)

link で指定されたWSTP接続から16ビットの整数を得て,C関数のshort型としてi に保持する.

詳細

  • リンク上のデータが実数に対応するものであれば,WSGetInteger16()はそれを整数に丸める.
  • リンク上のデータが,ユーザのコンピュータシステム上のC言語のshort型で保持するには大きすぎる整数に対応するものであれば,WSGetInteger16()は失敗し,0を返す.
  • 任意精度の整数は,まずIntegerDigitsで桁数のリストを生成し,次にWSGetInteger16List()を呼び出せば得られる.
  • WSGetInteger16()は,関数が成功すると0以外の値を返す.
  • WSError()を使うと,WSGetInteger16()が不成功の場合にエラーコードを引き出すことができる.
  • WSGetInteger16()は,WSTPヘッダファイルwstp.hの中で宣言される.

例題

  (1)

#include "wstp.h"

/* read a short integer from a link */

void f(WSLINK lp)
{
    short s;

    if(! WSGetInteger16(lp, &s))
        { /* unable to read the integer from lp */ }

    /* use the short integer */
}