WSGetInteger32 （C 関数）

int WSGetInteger32(WSLINK link,int *i)

link で指定されたWSTP接続から32ビットの整数を得て，i に保持する．

詳細

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

例題

例  (1)

#include "wstp.h"

/* read a 32-bit integer from a link */

void f(WSLINK lp)
{
    int data;

    if(! WSGetInteger32(lp, &data))
        { /* unable to read an integer from lp */ }

    /* use the integer */
}