バージョンごとのドキュメント一覧

SPI_getargtypeid

SPI_getargtypeid <refpurpose>return the data type OID for an argument of a statement prepared by <function>SPI_prepare</function></refpurpose> SPI_prepareで準備された文で指定される引数のデータ型のOIDを返す

概要

Oid SPI_getargtypeid(SPIPlanPtr plan, int argIndex)

説明

<title>Description</title>

<function>SPI_getargtypeid</function> returns the OID representing the type for the <parameter>argIndex</parameter>'th argument of a statement prepared by <function>SPI_prepare</function>. First argument is at index zero. SPI_getargtypeidは、SPI_prepareで準備された文におけるargIndex番目の引数の型を表すOIDを返します。 インデックス0は最初の引数を示します。

引数

<title>Arguments</title>
SPIPlanPtr plan

prepared statement (returned by <function>SPI_prepare</function>) SPI_prepareで返される)準備済み文

int argIndex

zero based index of the argument 0から始まる引数のインデックス

戻り値

<title>Return Value</title>

The type OID of the argument at the given index. If the <parameter>plan</parameter> is <symbol>NULL</symbol> or invalid, or <parameter>argIndex</parameter> is less than 0 or not less than the number of arguments declared for the <parameter>plan</parameter>, <varname>SPI_result</varname> is set to <symbol>SPI_ERROR_ARGUMENT</symbol> and <symbol>InvalidOid</symbol> is returned. 指定したインデックスにおける引数の型OIDです。 planNULLまたは無効、あるいはargIndexが0未満、planで宣言された引数の数以上の場合、SPI_resultSPI_ERROR_ARGUMENTが設定され、InvalidOidが返されます。