カテゴリ別プロパティ、メソッド、およびイベント
 
このページをシェアする                  
カテゴリ別プロパティ、メソッド、およびイベント
この章は、PSQL 用に設計されたプロパティ、メソッド、およびイベントすべてを一覧にまとめ、次のセクションで機能別に説明します。
ActiveX のプロパティ、メソッド、およびイベントの概要
レコード セットの取得
ファイルの処理
データ辞書メソッド
レコード内のフィールドへのアクセス
レコードの挿入、更新、および削除
個別レコードの取得
最適化とデバッグ
ActiveX のプロパティ、メソッド、およびイベントの概要
プロパティ、メソッド、およびイベントは、ActiveX コントロールに適用できる 3 種類の機能です。
プロパティとメソッドの違いは必ずしも明らかではありませんが、次のような文で明確にすることができます。
Let variable = method は一般に文法的に正しい構文です。Let method = variable は、誤った構文です。
Let property = variable および Let variable = property は、両方とも文法的に正しい構文です。
イベントは、ActiveX コントロールによってトリガーされるアプリケーション内の関数で、ユーザーはこれに応答できます。
メモ: この章に記載されているプロパティ、メソッド、およびイベントは、ActiveX アクセス方法用に設計されたものです。また、開発ツール(Visual Basic など)で提供されるコントロールに関連付けられたほかのプロパティ、メソッド、およびイベントについても説明されています。特定の開発ツールの情報についてはそのツールのマニュアルを参照してください。
レコード セットの取得
ここでは、レコード セットを取得する際に使用できるプロパティ、メソッド、およびイベントの一覧を示します。
プロパティとメソッド
 
表 22 Extended オペレーション用プロパティおよびメソッド
プロパティまたはメソッド
説明
Extended Fetch データ セットの自動キャッシュ処理を有効または無効にします。
SelectedRecords 条件を使用した単一 Extended Fetch オペレーションの処理でスキップ可能な最大レコード数を決定します。
単一 Extended Fetch オペレーションによって返される最大行数を決定します。
ユーザーが一連の単一 Extended Fetch オペレーションをキャンセルすることのできるダイアログ ボックスを有効または無効にします。
Extended Fetch 結果セットの現在の列を決定します。
Extended Fetch 結果セットの現在の列の名前を指定します。デフォルトは列に割り当てられたフィールド名です。
Extended Fetch 結果セットの合計列数を返します。
データ ソースに対して Extended Fetch プロパティおよびメソッドを有効または無効にします。
テキスト ボックスがフォーカスを取得したときの VAText ボックス内のテキストを選択します。
現在のカーソル位置から始まり、現在のインデックス パスに沿って進行する Extended Fetch を実行します。
現在のカーソル位置から始まり、現在のインデックス パスを遡る Extended Fetch を実行します。
次に実行される Extended Fetch オペレーションのレコード セットの結果に現在のレコードを含めるか、あるいは後続のレコードから始めるかどうかを決定します。
SelectedFields または SelectedRecords 条件を変更した後、あるいは新たに現在位置をファイル内で設定した後で Extended Fetch メソッドを呼び出す前に、Extended Fetch パラメーターを割り当てます。
Extended Fetch オペレーションで使用するデータ バッファーのサイズを指定します。
Extended Fetch の結果セットの現在の行を設定あるいは返します。Extended Fetch メソッドからの結果セットへアクセスする場合に、あるいは検索条件を満たす行間を移動する場合に使用します。
Extended Fetch 結果セット内の指定された行と列からフィールド値を返します。
Extended Fetch 結果セット内の現在の行にあるレコードの物理位置を返します。
Extended Fetch 結果セット内のデータの有効行数を返します。
Extended Fetch 結果セットの列として使用するフィールドを指定します。デフォルトは空のリストで、これはすべてのフィールドが含まれることを示します。
Extended Fetch 結果セットに返されるレコードのレコード選択条件を指定します。デフォルトは空のリストで、これはすべてのレコードが含まれることを示します。
SelectedFields プロパティの[プロパティの設定]ダイアログ ボックスを表示します。
SelectedRecords プロパティの[プロパティの設定]ダイアログ ボックスを表示します。
現在の位置から始まり、物理レコード順を前方へ進む Extended Fetch を実行します。
現在の位置から始まり、物理レコード順を後方へ進む(遡る)Extended Fetch を実行します。
イベント
 
表 23 Extended オペレーション用イベント
イベント
説明
Extended Fetch 操作の完了に伴ない発生します。返されたデータ バッファーに含まれるデータの行数および列数を返します。
ファイルの処理
ここでは、ファイル処理を実行する際に使用できるプロパティとメソッドの一覧を示します。
プロパティとメソッド
 
表 24 ファイルの処理用プロパティおよびメソッド
プロパティまたはメソッド
説明
Extended Fetch データ セットの自動キャッシュ処理を有効または無効にします。
コントロールに関連付けられたファイルを閉じます。
ファイルに対する単一レコード オペレーションで使用されるレコード データ バッファーのバイト長を取得または設定します。
特定のデータ定義ファイル セットに VAccess コントロールを接続します。
PSQL ファイルのバージョンを返します。
現在のデータ バッファーを新たなレコードとして挿入を試みます。
選択された VAccess コントロールに関連付けられたテーブルのドライブ、パス、ファイル名を設定するか、あるいは返します。
コントロールに関連付けられたファイルを開きます。
コントロールに関連付けられているファイルのオープン モードを取得または設定します。
VAccess コントロールに関連付けられたファイルを開くときに使用される PSQL オーナー ネームを指定します。
PSQL データ ファイルのページ サイズを取得または設定します。
ファイルのオーナー ネームを設定します。
コントロールに関連付けられたファイルから現在のファイルのステータス情報を取得します。
コントロールに関連付けられているテーブルを示します。
VAccess コントロールに関連付けられた PSQL ファイルに含まれているレコード数を返します。
データ辞書メソッド
ここでは、データ辞書メソッドに使用できるプロパティとメソッドの一覧を示します。
プロパティとメソッド
 
表 25 データ辞書処理用プロパティおよびメソッド
プロパティまたはメソッド
説明
DDF ファイルおよび対応する PSQL ファイルにインデックスを追加します。
現在のテーブルを現在のデータ辞書に追加します。
現在の VAccess コントロール メモリ イメージに新たなテーブルを追加します。
現在のテーブルの VAccess メモリ イメージのフィールド情報を消去します。
現在のテーブルの VAccess メモリ イメージのインデックス情報を消去します。
現在の位置に新たに空の DDF ファイル セットを作成します。
辞書にテーブル定義を追加し、空のデータ ファイルを作成します。
現在の PSQL データ ファイルと現在のテーブルのデータ辞書定義からインデックスを削除します。
既存インデックスの順序はそのまま維持して、現在の PSQL データ ファイルと現在のテーブルのデータ辞書定義からインデックスを削除します。
現在のテーブルをデータ辞書から削除します。
COMMENT.DDF ファイルからフィールド コメントを VAccess メモリ イメージに読み取ります。
VAccess がファイルの実際のインデックスを使用するか、あるいは DDF に指定されたインデックスを使用するかを指定します。
現在のテーブルの場所を変更し、オプションとして DDF に新しい場所を書き込みます。
現在のテーブルの名前を変更し、オプションとして DDF に新たな名前を書き込みます。
このコントロールに関連付けられた DDF ファイルが常駐するドライブとパスを設定します。
辞書ファイルの Btrieve オーナー ネームをデフォルトのオーナー ネーム(..SC....)セキュリティ レベル(読み取り専用アクセス)以外に設定します。
辞書を開く際に使用するオーナー ネームを設定し、このオーナー ネームを使用して辞書が正常に開き、更新できるかどうかを判定します。
データ辞書テーブルへの更新がトランザクション内で実行されるかどうかを判定します。ブール値を受け付けます。またはブール値を返します。
現在のテーブルのフィールドに関する情報を含むバリアント配列を設定します。あるいはそのバリアント配列を返します。
現在の辞書に定義されているテーブルのリストを 2 次元バリアント配列として返します。
現在のテーブルのインデックスに関する情報を含むバリアント配列を設定します。あるいはそのバリアント配列を返します。
VAccess コントロールに関連付けられている PSQL ファイルのドライブ、パス、ファイル名を取得または設定します。
VAccess コントロールがメタデータに対し、DDF ファイルを使用するのか、あるいは内部状態と永続的なプロパティ(またはどちらか一方)を使用するのかを判定します。
現在の DDF セットに定義されているすべてのテーブルから、どのテーブルが目的のコントロールと関連付けられているかを示します。
レコード内のフィールドへのアクセス
ここでは、レコード内のフィールドにアクセスする際に使用できるプロパティとメソッドの一覧を示します。
プロパティとメソッド
 
表 26 レコード内のフィールドへのアクセス用プロパティおよびメソッド
プロパティまたはメソッド
説明
現在のテーブルのフィールドに関する情報を含むバリアント配列を設定します。あるいはそのバリアント配列を返します。
関連付けられたファイルに定義されたフィールドの合計数を設定します。またはその合計数を返します。
メモリ内の現在のレコード、あるいは Extended Fetch レコード セットの現在の行に対して指定されたフィールドの値を取得または設定します。
指定の書式文字列を使用して書式設定された現在のレコードのフィールドの値を返します。
英数字フィールドに保存されたデータを ANSI 文字セットと OEM 文字セットの間で変換します。
レコードの挿入、更新、および削除
ここでは、レコードを挿入、更新、削除する際に使用できるプロパティ、メソッド、イベントの一覧を示します。
プロパティとメソッド
 
表 27 レコードの挿入、更新、および削除用プロパティおよびメソッド
プロパティまたはメソッド
説明
コントロールの現在のレコード バッファーの内容を取得または設定します。
メモリ内の現在のレコードのデータとインデックス バッファーの内容を消去します。
現在のレコードを削除します。
メモリのレコードを新規レコードとしてファイルに挿入します。
バウンド コントロールを再描画します。
トランザクションを開始、終了、あるいは中断します。
ロックされたレコードのロックを解除します。
現在のレコードをメモリ内のレコード イメージに更新します。
イベント
 
表 28 レコードの挿入、更新、および削除用イベント
イベント
説明
関連付けられたテーブルでレコード操作が行われる前に発生します。
個別レコードの取得
ここでは、レコード セットを取得する際に使用できるプロパティ、メソッド、イベントの一覧を示します。
プロパティとメソッド
 
表 29 個別レコード取得用プロパティおよびメソッド
プロパティまたはメソッド
説明
コントロールの現在のレコード バッファーの内容を取得または設定します。
ファイル内の物理位置を使用してレコードを返します。
現在のインデックスと完全に一致するレコードを返します。
現在のインデックス パスにある最初のレコードを返します。
現在のインデックス パスにある現在のキー値よりも大きい最初のレコードを返します。
現在のインデックス パスにある現在のキー値と等しい、あるいは現在のキー値よりも大きい最初のレコードを返します。
現在のインデックス パスにある最後のレコードを返します。
現在のインデックス パスにある、キー フィールドに指定された値よりも小さい値を含む最後のレコードを返します。
現在のインデックス パスにある、キー フィールドに指定された値よりも小さいまたは等しい値を含む最後のレコードを返します。
現在のインデックス パスにある次のレコードを返します。
現在のインデックス パスにある前のレコードを返します。
VAccess コントロールに関連付けられているファイルの、特定のインデックスに含まれるセグメントの総数を返します。
VAccess コントロールに関連付けられたテーブルの現在のインデックス番号を返します。
関連付けられたテーブルの現在選択されているインデックス パス上の指定された相対位置に、取得するレコードを設定します。
VAccess コントロールに関連付けられたテーブルの現在のレコードの物理位置の値を返します。
VAccess コントロールがメタデータに対し、DDF ファイルを使用するのか、あるいは内部状態と永続的なプロパティ(またはどちらか一方)を使用するのかを判定します。
物理レコードの格納順での最初のレコードを返します。
物理レコードの格納順での最後のレコードを返します。
物理レコードの格納順での次のレコードを返します。
物理レコードの格納順での前のレコードを返します。
イベント
 
表 30 個別レコード取得用イベント
イベント
説明
関連付けられたテーブルでレコード操作が行われる前に発生します。
最適化とデバッグ
ここでは、最適化とデバッグ機能を実行する際に使用できるプロパティとメソッドを一覧にまとめてあります。
プロパティとメソッド
 
表 31 最適化とデバッグ用プロパティおよびメソッド
プロパティまたはメソッド
説明
VAccess コントロールのイベントの発生を有効または無効にします。
コントロールで使用可能なレコードを制限し、別の VAccess コントロールのフィールド値を基準とする、関連テーブルのリレーショナルな位置を維持します。
クライアントが使用するセッション ID を取得または設定します。
VAccess コントロールに関連付けられたファイルに対する最新の PSQL オペレーションから PSQL ステータスを返します。
ゼロ以外の数値に設定されると、タスク モードのメッセージ ボックスを表示します。
コントロールに対するデバッグ モードのエラー チェック機能を有効または無効にします。