目的
Get Attributeは、オペレータに関連する特定の属性の値を抽出するサービス関数です。
構造
#include <pxoper.h> PXSTC_Code PX_GetAttribute(PX_OperatorHandle operator, PX_AttributeName attributeName, PX_AttributeValue * attributeValue, PX_Length * valueLength);
次のような場合に当てはまります。
パラメータ | 関数 | 指定 |
---|---|---|
attributeName | 入力 | オブジェクト属性の名前 |
attributeValue | 出力 | 指定された属性の抽出された値 |
operator | 入力 | 属性の抽出先となるオペレータ ハンドル |
valueLength | 出力 | 抽出された属性値の長さ |
戻りコード
以下のGet Attribute関数のステータス コードは、Teradata PTオペレータ インターフェースによって定義されます。
ステータス コード | 意味 |
---|---|
PXSTC_InvalidArgument | 1つ以上の正しくない入力引数 |
PXSTC_BadHandle | 未定義のオブジェクト ハンドル |
PXSTC_NotFound | 指定された属性が、指定されたオブジェクト内で見つからない |
PXSTC_Success | 指定された属性へのアクセスの成功 |
使用上の注意
Get Attribute関数を定義する場合の注意事項は、以下を考慮してください。
対象 | 使用上の注意 |
---|---|
システム属性 | 次のテーブルは、Get Attributes関数で取得できるTeradata PTシステム属性を示します。 Put Attributeも参照してください。 |
ステータス | 関数のステータスがPXSTC_Successの場合は、次のようになります。
|
属性名 | データ型 | データ長 (単位: バイト) | 説明 |
---|---|---|---|
SYSTEM_Code | PX_Code | 4 | System ABENDコード |
SYSTEM_FilterHandle | PX_FilterHandle | 4 | フィルタ オブジェクトのハンドル |
SYSTEM_GlobalHandle | PX_GlobalHandle | 4 | グローバル アンカーのハンドル |
SYSTEM_InstanceNumber | PX_Number | 4 | 1から始まるオペレータのインスタンス番号 |
SYSTEM_MaxInstances | PX_Count | 4 | そのオペレータに関して作成できるインスタンスの最大数 |
SYSTEM_OperatorName | PX_Addr | 4 | オペレータ名を含む文字列のアドレス |
SYSTEM_OperatorType | PX_Number | 4 | オペレータのタイプを示すコードproducer=1、consumer=2、filter=3 |
SYSTEM_PhaseNumber | PX_Count | 4 | 現在の処理フェーズ番号 |
SYSTEM_UserAreaAddr | PX_Addr | 4 | ユーザー域のアドレス |