第 5 章 LCField クラス
この章では、LCField クラスのメソッドおよびプロパティについて説明します。
LCField クラスの概要
LCField クラスは、指定されたデータ型のデータ値を 1 つ以上格納するデータオブジェクトを表します。LCField クラスの大部分のメソッドには、フィールドに複数の値がある場合にどの値を操作するかを指定する「インデックス」引数があります。インデックスの値は 1 から始まります。
LEI Scripted アクティビティの構文 - 1
LEI Scripted アクティビティ向けの LotusScript® Extensions (LC LSX) スクリプトを記述するときには、Dim LCSession を名前付きのセッションとして指定する必要があります。これが、デフォルトのログ文書名となります。LCConnections も、既存の名前付き IBM® Lotus Enterprise Integrator® (LEI) コネクション文書として宣言する必要があります。
LCField クラスのメソッドおよびプロパティの要約
LCField クラスのメソッドの要約を以下に示します。
LCField の New メソッド
LCField のコンストラクタメソッドです。LCField オブジェクトを初期化します。
LCField の ClearVirtualCode メソッド
このメソッドは、フィールドに指定されている仮想コードをクリアします。仮想コードは、別のシステムによって認識される特別なシステムプロパティとしてフィールドにフラグを付けるものです。コネクションごとにサポートされる固有のコードについては、Connector のドキュメントを参照してください。
LCField の Compare メソッド
このメソッドは、2 つのフィールドのデータ値を比較し、その関係を返します。
LCField の Convert メソッド
このメソッドは、データ値をターゲットフィールドのデータ型に変換します。
LCField の Copy メソッド
このメソッドは、ソースフィールドの設定および値を使用して、フィールドを作成します。新しいフィールドのデータ値の数とデータ型は、ソースフィールドと同じです。新しいフィールドは、元のデータへの参照ではなくコピーです。
LCField の GetCurrency メソッド
このメソッドは、フィールドの値から Currency データ型を取り出します。要求されたデータ型がフィールドのデータ型と異なる場合は、自動的に変換を実行します。変換を実行できない場合は、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の GetDatetime メソッド
このメソッドは、フィールドの値から Datetime データ型を取り出します。要求されたデータ型がフィールドのデータ型と異なる場合は、自動的に変換を実行します。変換を実行できない場合は、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の GetFieldlist メソッド
このメソッドは、フィールドからフィールドリストを取り出します。取り出されたフィールドリストは、フィールド内の元の情報への参照です。フィールドの値に LCFieldlist が含まれていない場合は、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の GetFloat メソッド
このメソッドは、フィールドの値から LotusScript の double データ型を取り出します。要求されたデータ型がフィールドのデータ型と異なる場合は、自動的に変換を実行します。
LCField の GetFormatDatetime メソッド
このメソッドは、Datetime 型フィールドの形式を取り出します。Datetime 型のフィールドのみに有効です。
LCField の GetFormatNumber メソッド
このメソッドは、数値型フィールドの形式を取り出します。データ型が int、currency、float、または numeric のフィールドのみに有効です。
LCField の GetFormatStream メソッド
このメソッドは、ストリーム型フィールドの形式を取り出します。text 型または binary 型のフィールドのみに有効です。
LCField の GetInt メソッド
このメソッドは、フィールドの値から整数を取り出します。要求されたデータ型がフィールドのデータ型と異なる場合は、自動的に変換を実行します。変換を実行できない場合は、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の GetNumeric メソッド
このメソッドは、フィールドの値から numeric 値を取り出します。要求されたデータ型がフィールドのデータ型と異なる場合は、自動的に変換を実行します。変換を実行できない場合は、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の GetStream メソッド
このメソッドは、フィールドからストリーム値を取り出します。要求されたデータ型がフィールドのデータ型と異なる場合は、自動的に変換を実行します。変換を実行できない場合は、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の IsNull メソッド
このメソッドは、指定されたフィールドのデータが NULL かどうかに応じて、true または false を返します。フィールドには複数の値を格納でき、その一部だけが NULL ということもあります。
LCField の LookupVirtualCode メソッド
このメソッドは、指定された仮想コードがフィールドに設定されているかどうかをチェックします。仮想コードは、別のシステムによって認識される特別なシステムプロパティとしてフィールドにフラグを付けるものです。コネクションごとにサポートされる固有のコードについては、Connector のドキュメントを参照してください。
LCField の SetCurrency メソッド
このメソッドは、フィールドの値を指定された LCCurrency 値に設定します。フィールドのデータ型が Currency でない場合は、指定した値はフィールドのデータ型に変換されます。変換に失敗すると、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の SetDatetime メソッド
このメソッドは、フィールドの値を指定された LCDatetime 値に設定します。フィールドのデータ型が datetime でない場合は、指定した値はフィールドのデータ型に変換されます。変換に失敗すると、LCFAIL_INVALID_CONVERT エラーが発生します。日時データは、ストリームデータ型にのみ変換できます。
LCField の SetFieldlist メソッド
このメソッドは、フィールドリストの値を、フィールドの指定されたインデックスに割り当てます。フィールドのデータ型が異なる場合は、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の SetFloat メソッド
このメソッドは、float 型フィールドに値を割り当てます。フィールドのデータ型が異なる場合は、変換が試行されます。変換に失敗すると、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の SetFormatDatetime メソッド
このメソッドは、datetime フィールドの形式設定を変更します。このメソッドを呼び出すと、このフィールドの値はすべてクリアされます。フィールドが datetime 型でない場合は、LCFAIL_TYPE_MISMATCH エラーが発生します。
LCField の SetFormatNumber メソッド
このメソッドは、数値フィールドの現在の形式設定を割り当てます。このメソッドを呼び出すと、このフィールドの値はすべてクリアされます。
LCField の SetFormatStream メソッド
このメソッドは、ストリームフィールドの現在の形式設定を割り当てます。このメソッドを呼び出すと、このフィールドの値はすべてクリアされます。
LCField の SetInt メソッド
このメソッドは、フィールドの値を指定された長整数値に設定します。フィールドの型が LCTYPE_INT でない場合は、フィールドの型の値に変換されます。変換に失敗すると、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の SetNull メソッド
このメソッドは、フィールドの値を特別な値である NULL に設定します。リレーショナルデータベースでは、この値が空白のフィールドとして認識されます (例えば、長さがゼロの文字列を含むフィールドとは異なります)。
LCField の SetNumeric メソッド
このメソッドは、フィールドの値を指定された LCNumeric 値に設定します。フィールドの型が LCTYPE_NUMERIC でない場合は、フィールドの型の値に変換されます。変換に失敗すると、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の SetStream メソッド
このメソッドは、フィールドの値を指定された LCStream 値 (テキストまたはバイナリ) に設定します。フィールドの型が LCTYPE_STREAM でない場合、またはフィールドの形式が指定された値と一致しない場合 (バイナリに対してテキストである場合など) は、値はフィールドの型に変換されます。変換に失敗すると、LCFAIL_INVALID_CONVERT エラーが発生します。
LCField の SetVirtualCode メソッド
このメソッドは、フィールドの仮想コードリストに仮想コードを追加します。仮想コードは、別のシステムによって認識される特別なシステムプロパティとしてフィールドにフラグを付けるものです。コネクションごとにサポートされる固有のコードについては、Connector のドキュメントを参照してください。
親トピック:
LSX for Lotus Connectors