SPI_getbinval

PostgreSQL 18.0文書
		45.2. インタフェースサポート関数	誤訳等の報告
前へ	上へ	SPI_getbinval	次へ

SPI_getbinval <refpurpose>return the binary value of the specified column</refpurpose> — 指定した列のバイナリ値を返す

概要

Datum SPI_getbinval(HeapTuple row, TupleDesc rowdesc, int colnumber,
                    bool * isnull)

説明

<title>Description</title>

<function>SPI_getbinval</function> returns the value of the specified column in the internal form (as type <type>Datum</type>). SPI_getbinval は指定された列の値を内部形式で（Datumとして）返します。

This function does not allocate new space for the datum. In the case of a pass-by-reference data type, the return value will be a pointer into the passed row. この関数はデータ用に新しい領域を確保しません。参照渡しのデータ型の場合、戻り値は渡された行の内部を示すポインタとなります。

引数

<title>Arguments</title>

HeapTuple row: input row to be examined 対象とする入力行
TupleDesc rowdesc: input row description 入力行の記述
int colnumber: column number (count starts at 1) （1から始まる）列番号
bool * isnull: flag for a null value in the column 列のNULL値についてのフラグ

戻り値

<title>Return Value</title>

The binary value of the column is returned. The variable pointed to by <parameter>isnull</parameter> is set to true if the column is null, else to false. 列のバイナリ値が返されます。 isnullで指し示される変数は、列がNULLならば真に、さもなくば、偽に設定されます。

<varname>SPI_result</varname> is set to <symbol>SPI_ERROR_NOATTRIBUTE</symbol> on error. エラー時、SPI_resultはSPI_ERROR_NOATTRIBUTEに設定されます。

前へ	上へ	次へ
SPI_getvalue	ホーム	SPI_gettype