17.00 - 17.05 - FNC_TblOpGetFormat - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL外部ルーチン プログラミング

Product
Advanced SQL Engine
Teradata Database
Release Number
17.00
17.05
Published
2020年6月
Content Type
プログラミング リファレンス
Publication ID
B035-1147-170K-JPN
Language
日本語 (日本)

目的

事前にFNC_TblOpSetFormatを呼び出すことにより、コントラクト関数におけるデフォルト形式または形式セットを返します。

構文規則

void
FNC_TblOpGetFormat(char                  *attribute,
                   int                    streamno,
                   Stream_Direction_en    direction,
                   void                  *outValue,
                   int                    outSize);
char *attribute
取得するべき形式属性。現在指定可能な値は「RECFMT」のみです。
int streamno
ストリーム番号。
Stream_Direction_en direction
ストリームの方向'R'または'W'。
void *outValue
形式属性値が返されるバッファ。
int outSize
outValueバッファのバイト単位のサイズ。

使用上の注意

形式属性「RECFMT」は、入出力記録属性を定義し、以下の指定可能な値は2つあります。

typedef enum
{
    INDICFMT1 = 1,        /* IndicData with row separator sentinels */
    INDICBUFFMT1 = 2      /* IndicData with NO row or partition separator sentinels */
} Stream_Fmt_en;

形式属性が「RECFMT」の場合には、outvalueバッファのサイズはsizeof(Stream_Fmt_en)に、返される属性値はINDICFMT1 (行セパレータ センチネル付きIndicData)またはINDICBUFFMT1 (行/パーティッション セパレータ センチネルなしIndicData)になります。メモリは、FNC_TblOpGetFormatを呼び出す前にoutvalueバッファに割り当て、バッファが不要になった場合には解放する必要があります。