WSBytesToPut (C 関数)

int WSBytesToPut(WSLINK link,int *n)

現行データのテキスト表現の中にまだ書き込まれていないバイト数を計算し,その結果をn に保存する.

詳細

  • WSTPは文字列,シンボル,整数,浮動小数点数を送るために,WSPutString()WSPutSymbol()WSPutInteger32()WSPutReal64()等の関数を供給する.しかし文字列表示を使ってこれらの形式のものを送るほうが便利な場合もときにはある.WSBytesToPut()は,WSPutType()WSPutRawSize()WSPutRawData()を使って,文字列表示を使う形式のものを送ることができる.
  • WSBytesToPut()はエラーがあると0を返し,関数が成功すると0以外の値を返す.
  • WSError()を使うと,WSBytesToPut()が不成功の場合にエラーコードを引き出すことができる.
  • WSBytesToPut()は,WSTPヘッダファイルwstp.hの中で宣言される.

例題

  (1)

#include <string.h>
#include "wstp.h"

/* send an approximation of Pi across a link */

void f(WSLINK lp)
{
    char *Pi = "3.141592654";
    int bytes_left, i;

    if(! WSPutType(lp, WSTKOLDREAL))
        { /* unable to send the data type to lp */ }

    if(! WSPutRawSize(lp, strlen(Pi))
        { /* unable to send the length of Pi to lp */ }

    if(! WSBytesToPut(lp, &bytes_left))
        { /* unable to get the remaining bytes to send from lp */ }

    i = 0;
    while(bytes_left > 0)
    {
        /* send the data one byte at a time */
        if(! WSPutRawData(lp, Pi + i, 1))
            { /* unable to send a character of Pi to lp */ }

        if(! WSBytesToPut(lp, &bytes_left))
            { /* unable to get the remaining bytes to send from lp */ }

        i++;
    }
}