この章では、ActiveX アクセス方法のメソッドについて説明します。アルファベット順にメソッドを説明します。

Vaccess、VACombo、VAList、VACommand、VAHScroll、VAVScroll、VAOption、VAText

ActiveX コントロールの著作権とバージョン情報を表示します。

VACombo、VAList

フィールド バウンド モードで動作している VAList コントロールまたは VACombo コントロールに項目を追加します。

AddItem メソッドの構文は次のような要素で構成されます。

index に有効な値を入力すると、item が object 内の指定位置に配置されます。index を省略すると、item は適切にソートされた位置（Sorted プロパティが True に設定されている場合）か、一覧の最後（Sorted プロパティが False に設定されている場合）に追加されます。

レコード リスト モードで動作している（VARecordList プロパティが True に設定されている）VAList コントロールまたは VACombo コントロールは、AddItem メソッドをサポートしません。

VAccess

VAccess コントロールに関連付けられているファイルに対して Pervasive PSQL オペレーションを実行し、そのオペレーションのステータスを返します。

Btrv メソッドの構文は次のような要素で構成されます。

VAccess コントロールで実行可能な Pervasive PSQL 関数はどれでも、Btrv メソッドを用いて使用することができます。このメソッドは単一パラメーター、opcode を使用します。opcode 定数宣言は、GLOBAL.BAS ファイル（Visual Basic の場合）、GLOBAL.PAS ファイル（Delphi の場合）および GLOBAL.H ファイル（Visual C++ の場合）に含まれています。アプリケーションで opcode 定数を使用するには、これらのファイルのうち 1 つ、開発環境に適したファイルをプロジェクトに含めます。

次のような opcode 設定が可能です。

オペレーション コードにロック バイアスを加算することによって、Pervasive PSQL のレコードをロックできます。Btrv では Get または Step オペレーションにロックを指定することができます。ロックを解除する場合は、Unlock メソッドを使用します。ロック バイアスは次のとおりです。

Vaccess、VACombo、VAList

VAList または VACombo の内容をクリアし、VAccess コントロールのデータ バッファーとインデックス バッファーの内容をクリアします。

Clear メソッドの構文は次のような要素で構成されます。

レコード リスト モードで動作している（VARecordList プロパティが True に設定されている）VAList コントロールまたは VACombo コントロールは、Clear メソッドをサポートしません。

VAccess

VAccess コントロールに関連するファイルを閉じ、Close オペレーションのステータスを返します。

Close メソッドの構文は次のような要素で構成されます。

このメソッドは object に関連付けられているファイルを閉じ、そのオペレーションの Pervasive PSQL ステータス コードを返します。戻り値がゼロであれば正常に実行されています。

VAccess

DDF ファイルおよび対応する Pervasive PSQL ファイルにインデックスを追加します。正常に実行された場合は 0 を、エラーが発生した場合は Pervasive PSQL ステータス コードを返します。

DdfAddIndex メソッドの構文は次のような要素で構成されます。

DdfAddIndex は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfAddIndex は実際のデータ ファイル自体に indexList のインデックスを追加します。また、この関数は indexList のインデックスを VAccess コントロールのメタデータ メモリ イメージに追加します。RefreshLocations が True の場合、DdfAddIndex は現在のメモリ イメージと一致するように DDF ファイルを更新します。DdfTransactionMode が True の場合、これらの操作はトランザクション内部で実行されます。

IndexList、RefreshLocations、DdfTransactionMode、DdfDropIndex

VAccess

TableName、Location、FieldList、IndexList の値によって定義される現在のテーブルを現在の DDF に追加します。

DdfAddTable メソッドの構文は次のような要素で構成されます。

DdfAddTable は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfAddTable は VAccess コントロールの現在のメモリ イメージにある情報を DDF ファイル自体に書き込みます。bOverwrite が True の場合、コントロールは同じ名前を持つ既存テーブルを上書きします。False の場合は、同名のテーブルが（DdfPath プロパティで指定された）現在の DDF に存在すると、このメソッドはエラーとなります。

この関数はメタデータの VAccess メモリ イメージやデータ ファイル自体を操作することはありません。新しい空のテーブルをメタデータの VAccess メモリ イメージに作成するには、DdfAddTableName メソッドを使用します。新しいテーブルを DDF および指定された場所にある対応する空のデータ ファイルに作成するには、DdfCreateTable メソッドを使用します。

ほかの多くの辞書メソッドやプロパティと異なり、DdfAddTable は RefreshLocations をチェックしません。これは DDF 情報を書き込むためだけに使用されるので、直接 DDF に書き込むことを想定しています。この動作は、VAccess メモリ イメージを使用して、一度のパスで DDF への変更を保管し、それらの変更を DDF へ書き込むつもりならば、RefreshLocations を切り替える必要はないということです（『Pervasive PSQL Programmer's Guide』を参照）。

DdfTransactionMode が True の場合、DDF への書き込みはトランザクション内部で実行されます。

DdfAddTableName、DdfCreateTable、DdfTransactionMode

VAccess

新しいテーブルを現在の VAccess コントロール メモリ イメージに追加し、関連付けられている Location、FieldList、および IndexList を初期化して、新しいテーブル定義を辞書に追加できるようにします。

DdfAddTableName メソッドの構文は次のような要素で構成されます。

DdfAddTableName は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfAddTableName は新規テーブルのメタデータを定義する際の最初のステップです。これは、VAccess コントロールのメモリ イメージだけに影響します。そのため、RefreshLocations または DdfTransactionMode の現在の値の影響は受けません。

DdfAddTable、DdfModifyTableName

VAccess

現在のテーブルの VAccess メモリ イメージ（およびオプションで DDF）のフィールド情報をクリアします。

DdfClearFields メソッドの構文は次のような要素で構成されます。

DdfClearFields は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfClearFields は必ず VAccess メモリ イメージの現在のフィールド情報を破棄します。RefreshLocations が True の場合は、FIELD.DDF の現在のテーブルのフィールド情報もすべて削除します。この副作用として、INDEX.DDF は正しいフィールド情報を取得できなくなるため、このような状況が起こった場合には事実上、このテーブルのメタデータはすべて破壊されます。このメソッドを呼び出す前に、RefreshLocations を False に設定することを強くお勧めします。

FieldList、RefreshLocations、DdfTransactionMode

VAccess

現在のテーブルの VAccess メモリ イメージ（およびオプションで DDF）のインデックス情報をクリアします。

DdfClearIndexes メソッドの構文は次のような要素で構成されます。

DdfClearIndexes は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfClearIndexes は必ず VAccess メモリ イメージの現在のフィールド情報を破棄します。RefreshLocations が True の場合、INDEX.DDF の現在のテーブルのすべてのインデックス情報も削除されます。このメソッドを呼び出す前に、RefreshLocations を False に設定することを強くお勧めします。

DdfClearIndexes、IndexList、RefreshLocations、DdfTransactionMode

VAccess

DdfPath プロパティによって指定された場所に一連の新たな空の DDF ファイルを作成します。これは、データのテーブル、インデックス、フィールドを含んでいないデータ辞書を作成します。これらは DdfCreateTable、DdfAddTableName、DdfAddTable、DdfAddIndex を使用して追加する必要があります。

DdfCreateDictionary メソッドの構文は次のような要素で構成されます。

DdfCreateDictionary は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfCreateDictionary は FILE.DDF、FIELD.DDF、INDEX.DDF の各システム ファイルを作成し、これらのファイルに自己参照型のシステム テーブル定義レコードを設定します。また、拡張辞書ファイルの FIELDEXT.DDF と COMMENT.DDF も作成します。

現在、指定された DdfPath パスに辞書が存在している場合、コントロールは bOverwrite をチェックして、現在の辞書を削除して書き直すかどうかを判定します。bOverwrite が True の場合、既存の辞書は破棄され、元に戻せなくなります。

DdfPath、DdfTransactionMode

VAccess

辞書にテーブル定義を追加し、Location プロパティに指定されているパスとファイル情報、および FieldList と IndexList によって定義されている属性を使用して、空のデータ ファイルを作成します。

DdfCreateTable メソッドの構文は次のような要素で構成されます。

DdfCreateTable は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

このメソッドは最初に DdfAddTable を呼び出し、テーブル定義を辞書に追加します。もし、この呼び出しが何らかの理由で失敗した場合、たとえば、テーブル定義が既に存在していて bOverwrite が False の場合は、DdfCreateTable も失敗します。DdfAddTable が正常に実行されると、このメソッドは Location を使って新たに空のデータ ファイルを作成します。また bOverwrite パラメーターによって、Location に存在するデータ ファイルを上書きするかどうかを制御します。

ほかの多くの辞書メソッドやプロパティと異なり、DdfCreateTable は RefreshLocations をチェックしません。これは VAccess メモリ イメージに影響しないので、DDF に直接書き込むことを想定しています。この動作は、VAccess メモリ イメージを使用して、一度のパスで DDF への変更を保管し、それらの変更を DDF へ書き込み、テーブルを作成するつもりならば、RefreshLocations を切り替える必要がないということです（『Pervasive PSQL Programmer's Guide』を参照）。

DdfAddTable

VAccess

現在の Pervasive PSQL データ ファイルからインデックスを削除します。また、RefreshLocations が True の場合は、現在のテーブルのデータ辞書定義からもインデックスを削除します。

DdfDropIndex メソッドの構文は次のような要素で構成されます。

DdfDropIndex は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfDropIndex は実際のデータ ファイル自体から指定されたインデックスを削除します。また、この関数は VAccess コントロールのメタデータ メモリ イメージからインデックスを削除します。RefreshLocations が True の場合、DdfDropIndex は現在のメモリ イメージと一致するように DDF ファイルを更新します。DdfTransactionMode が True の場合、これらの操作はトランザクション内部で実行されます。

ファイルの最後のインデックス以外のインデックスを削除すると、すべてのインデックスの番号が付け替えられます。たとえば、5 つのインデックスがあるテーブル内で 3 番目のキーが削除されると、キー #3 がキー #2 に、キー #4 がキー #3 になります。DdfDropIndexMaintain を使用すると、テーブルのその他のキーを混乱させることなく、インデックスを削除することができます。

IndexList、RefreshLocations、DdfAddIndex、DdfDropIndexMaintain

VAccess

現在の Pervasive PSQL データ ファイルからインデックスを削除します。RefreshLocations が True の場合、既存インデックスの順序を変更することなく、現在のテーブルのデータ辞書定義からインデックスを削除します。

DdfDropIndexMaintain メソッドの構文は次のような要素で構成されます。

DdfDropIndexMaintain は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfDropIndexMaintain は実際のデータ ファイル自体から指定されたインデックスを削除します。また、この関数は VAccess コントロールのメタデータ メモリ イメージからインデックスを削除します。RefreshLocations が True の場合、DdfDropIndex は現在のメモリ イメージと一致するように DDF ファイルを更新します。DdfTransactionMode が True の場合、これらの操作はトランザクション内部で実行されます。

DdfDropIndex とは異なり、DdfDropIndexMaintain はほかの既存キーの序数値を変更しません。削除されたキーを使用するアプリケーションだけが悪影響を受けます。

DdfDropIndexMaintain は、データ ファイル自体のインデックス構造を変更するので、正しく使用しないと非常に危険です。データ ファイルを使用する既存プログラムは、この操作を実行した後は動作しなくなる可能性があります。注意して使用してください。

IndexList、RefreshLocations、DdfAddIndex、DdfDropIndex

VAccess

TableName で指定される現在のテーブルをデータ辞書から削除します。

DdfDropTable メソッドの構文は次のような要素で構成されます。

DdfDropTable は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfDropTable は、現在のテーブルへのすべての参照を現在のデータ辞書から削除します。これはデータ ファイルにはまったく影響しません。

ほかの多くの辞書メソッドやプロパティと異なり、DdfDropTable は RefreshLocations をチェックしません。これは DDF 情報を削除することだけを目的としているので、DDF に直接書き込むことを想定しています。

DdfAddTable、DdfAddTableName、TableName

VAccess

COMMENT.DDF ファイルからフィールド コメントを VAccess メモリ イメージに読み取ります。

DdfGetFieldComments メソッドの構文は次のような要素で構成されます。

DdfGetFieldComments は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfGetFieldComments は VAccess メモリ イメージのフィールド コメント情報を強制的にリフレッシュします。DDF からメモリ イメージを更新すると自動的にこの情報もリフレッシュされるので、この操作が必要になることはまずありません。これは、RefreshLocations が False に設定されていて、DDF 情報が変わらない場合にのみ必要となります。コメント情報はほかの DDF 情報とは共存しません。

ほかの多くの辞書メソッドやプロパティと異なり、DdfGetFieldComments は RefreshLocations をチェックしません。これは DDF からの情報を更新することだけを目的としているので、DDF から直接読み取ることを想定しています。

FieldList

VAccess

現在のテーブルの場所を変更し、オプションとして DDF に新しい場所を書き込みます。

DdfModifyLocation メソッドの構文は次のような要素で構成されます。

DdfModifyLocation は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

RefreshLocations が True の場合、新しいテーブルの場所は、データ辞書の FILE.DDF レコードでも更新されます。False の場合は、VAccess メモリ イメージに対してのみ変更が行われます。DdfAddTable を使用して後から変更することもできます。

このメソッドにより、コントロールの Location プロパティの値も新しい場所を反映して変更されます。

DdfModifyLocation は自動的に Location プロパティを変更するので、DdfKeyUseIndexDDFOnly が False に設定されている場合は、現在の IndexList の内容をクリアして、新しい場所のインデックス情報を基に内容を置き換えます（まだファイルが存在していなければ、内容をクリアします）。新たなファイルを作成する場合は、DdfModifyLocation を呼び出す前ではなく、呼び出した後に IndexList プロパティを設定します。

Location、RefreshLocations、DdfAddTable、DdfModifyTableName

VAccess

現在のテーブルの名前を変更し、オプションとして DDF に新たな名前を書き込みます。

DdfModifyTableName メソッドの構文は次のような要素で構成されます。

DdfModifyTableName は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

DdfModifyTableName は現在のテーブルを変更しません。要求された名前のテーブルが既に存在する場合はエラーとなります。現在のテーブルを変更するには、TableName プロパティを使用します。現在のテーブル一覧に新しい空のテーブルを追加するには、DdfAddTableName を使用します。

RefreshLocations が True の場合、新しいテーブル名は、データ辞書の FILE.DDF レコードでも更新されます。False の場合は、VAccess メモリ イメージに対してのみ変更が行われます。DdfAddTable を使用して後から変更することもできます。

このメソッドにより、コントロールの TableName プロパティの値も新しい名前を反映して変更されます。

RefreshLocations、TableName、DdfAddTable、DdfAddTableName、DdfModifyLocation

VAccess

辞書ファイルの Btrieve オーナー ネームをデフォルトのオーナー ネームとセキュリティ レベル（読み取り専用アクセスが可能）以外に設定する際に使用できます。オーナー ネーム パラメーターとセキュリティ レベル パラメーターは Btrieve の表記規則に準じます。

DdfSetOwner メソッドの構文は次のような要素で構成されます。

次のセキュリティ レベル コードを DdfSetOwner の SecurityLevel パラメーターに渡すことができます。

定数宣言は、GLOBAL.BAS ファイル（16 ビット Visual Basic の場合）、GLOBAL.BAS ファイル（Visual Basic の場合）、GLOBAL.PAS ファイル（Delphi の場合）および GLOBAL.H ファイル（Visual C++ の場合）に含まれます。アプリケーションでセキュリティ レベル定数を使用するには、これらのファイルのうち 1 つ、開発環境に適したファイルをプロジェクトに含めます。

VAccess

辞書を開く際に使用するオーナー ネームを設定し、このオーナー ネームを使用して辞書が正常に開き、更新できるかどうかを判定します。

DdfTestOwnerName メソッドの構文は次のような要素で構成されます。

DdfTestOwnerName は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。これがゼロの場合、現在の辞書のオーナー ネームを使用して辞書を開き、更新することができます。

VAccess コントロールによって使用されるデフォルトの辞書のオーナー ネームは、通常、DDF ファイルを読み取りおよび更新用として開きます。ただし、一部の辞書ファイルではデフォルト以外のオーナー ネームになっている場合もあります。この場合は、DdfTestOwnerName を使用して辞書のオーナー ネームを設定し、DdfPath で指定される現在の辞書に対して、そのオーナー ネームをテストすることができます。

DdfTestOwnerName は最初に辞書を開こうとします。正常に開いたら、そのオーナー ネームでは更新が可能か、あるいは読み取り専用かを調べるために、最初のレコードの更新を試みます。返されたステータスは、そのオーナー ネームでファイルを開けるか、修正できるか、あるいはどちらもできないかを示します。

DdfSetOwnerName

VAccess

現在のレコードを削除し、Pervasive PSQL ステータス コードを整数値で返します。

Delete メソッドの構文は次のような要素で構成されます。

このメソッドは object に関連付けられているファイルから現在のレコードを削除し、そのオペレーションの Pervasive PSQL ステータス コードを返します。戻り値がゼロであれば正常に実行されています。

VAccess

指定の書式文字列を使用して書式設定された現在のレコードのフィールドの値を返します。

FormatFieldValue メソッドの構文は次のような要素で構成されます。

フィールドに書式が設定されている場合は、データ型に関わらず、そのフィールドの内容の値は必ず文字列として返されます（コンテナーは自動的にこれを String、Variant、AnsiString またはほかの種類の文字データに解釈します）。フィールドに書式が設定されていない場合、値はそのフィールドのデータ型と最も近いバリアント（Variant）として返されます。ほとんどのコントロール コンテナーは、バリアント（Variant）の戻り値を、文字列（Sting）より簡単、迅速に操作でき、インターナショナル化や書式の再設定を行うことができます。そのため、できれば書式設定されていないフィールドを取得することをお勧めします。

FieldValue、RowColumnValue、Column

VAccess

ファイル内で物理位置を使用してレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetDirect メソッドの構文は次のような要素で構成されます。

このメソッドは object に関連付けられているファイルから物理位置を使ってレコードを取得し、そのオペレーションの Pervasive PSQL ステータス コードを返します。戻り値がゼロであれば正常に実行されています。

VAccess

現在のインデックスと正確に一致するレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetEqual メソッドの構文は次のような要素で構成されます。

現在選択されているインデックス フィールドが、オペレーションの実行前にそのフィールドに指定された値と正確に一致する値を含んでいる、ファイル内の最初のレコードを取得します。

このメソッドを呼び出す前に、IndexNumber プロパティによって指定されるインデックスを構成するフィールドの値を設定します。キー フィールドが VA フィールド コントロールにバインドされている場合、その値はバウンド コントロールの内容を修正することによって設定されます。

これらの値をコードから設定するには、FieldValue プロパティを使用します。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティにも設定されます。ステータスがゼロの場合は正常に実行されたことを示します。

オペレーションの実行が成功するには、キーのすべてのセグメント内のすべてのフィールド、すべてのバイトが同等である必要があります。ステータス コード 4 は、オペレーションの前にキー フィールドに設定された値が現在のインデックス パスで検出されなかったことを示します。オルタネート コレーティング シーケンス（ACS）が指定された文字列キーは、オルタネート コレーティング シーケンスを用いてキー値を解釈するとき、ファイル内にそのキー値とバイト単位で同等のものがある場合にレコードを返します。これは、大文字と小文字を区別しない文字列キーの場合も同じです。

VAccess

現在のインデックス パスの最初のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetFirst メソッドの構文は次のような要素で構成されます。

このメソッドは、IndexNumber プロパティによって設定された、現在選択されているインデックス パスの最初のレコードを、object に関連付けられたファイルから取得します。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス 9 は、現在のインデックス パスにはレコードがないことを示します。

Visual Basic では、リスト ボックスあるいはコンボ ボックスを追加するには GetFirst が必要です。

VAccess

現在のインデックス パスのキーよりも大きい最初のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetGreater メソッドの構文は次のような要素で構成されます。

このメソッドは、現在選択されているインデックス フィールドが、オペレーションの実行前にそのフィールドに指定された値よりも大きい値を含んでいる最初のレコードを、コントロールに関連付けられたファイルから取得します。このオペレーションを実行する前に、IndexNumber プロパティで指定されたインデックスを構成するフィールドの値を設定する必要があります。

キー フィールドがフィールド コントロールにバインドされている場合、その値はバウンド コントロールの内容を修正することによって設定されます。これらの値をコードから設定するには、FieldValue プロパティを使用します。

オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス コード 9 は、ファイル内のレコードには、オペレーションの前に指定された値より大きいキー値のレコードがないことを示します。

VAccess

現在のインデックス パスのキーと等しいか、そのキーよりも大きい最初のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetGreaterOrEqual メソッドの構文は次のような要素で構成されます。

このメソッドは、現在選択されているインデックス フィールドが、オペレーションの実行前にそのフィールドに指定された値と等しいか、それよりも大きい値を含んでいる最初のレコードを、コントロールに関連付けられたファイルから取得します。

このメソッドを呼び出す前に、IndexNumber プロパティで指定されたインデックスを構成するフィールドの値を設定します。

キー フィールドがフィールド コントロールにバインドされている場合、その値はバウンド コントロールの内容を修正することによって設定されます。これらの値をコードから設定するには、FieldValue プロパティを使用します。

オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス コード 9 は、ファイル内のレコードには、オペレーションの前に指定されたキー値と等しいか、そのキー値より大きいキー値を持つレコードがないことを示します。

VAccess

現在のインデックス パスの最後のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetLast メソッドの構文は次のような要素で構成されます。

このメソッドは、IndexNumber プロパティによって設定された、現在選択されているインデックス パスの最後のレコードを、object に関連付けられたファイルから取得します。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス コード 9 は、現在のインデックス パスにはレコードがないことを示します。

VAccess

キー フィールドに指定された値より小さい値を持つ現在のインデックス パスの最後のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetLess メソッドの構文は次のような要素で構成されます。

このメソッドは、現在選択されているインデックス フィールドが、オペレーションの実行前にそのフィールドに指定された値よりも小さい値を含んでいる最後のレコードを、コントロールに関連付けられたファイルから取得します。

このメソッドを呼び出す前に、IndexNumber プロパティで指定されたインデックスを構成するフィールドの値を設定します。キー フィールドがフィールド コントロールにバインドされている場合、その値はバウンド コントロールの内容を修正することによって設定されます。これらの値をコードから設定するには、FieldValue プロパティを使用します。

オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス コード 9 は、ファイル内のレコードには、オペレーションの前に指定された値より小さいキー値のレコードがないことを示します。

VAccess

キー フィールドに指定された値と等しいか、その値より小さい値を持つ現在のインデックス パスの最後のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetLessOrEqual メソッドの構文は次のような要素で構成されます。

このメソッドは、現在選択されているインデックス フィールドが、オペレーションの実行前にそのフィールドに指定された値と等しいか、それよりも小さい値を含んでいる最後のレコードを、コントロールに関連付けられたファイルから取得します。

このメソッドを呼び出す前に、IndexNumber プロパティで指定されたインデックスを構成するフィールドの値を設定します。キー フィールドがフィールド コントロールにバインドされている場合、その値はバウンド コントロールの内容を修正することによって設定されます。これらの値をコードから設定するには、FieldValue プロパティを使用します。

オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス コード 9 は、ファイル内のレコードには、オペレーションの前に指定されたキー値と等しいか、そのキー値より小さいキー値を持つレコードがないことを示します。

VAccess

現在のインデックス パスの次のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetNext メソッドの構文は次のような要素で構成されます。

このメソッドは、IndexNumber プロパティによって設定された、現在選択されているインデックス パスの次のレコードを、そのコントロールに関連付けられたファイルから取得します。

このメソッドを呼び出す前に、インデックス パスに現在の位置を確立しておく必要があります。

オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス コード 9 は、現在のインデックス パスの現在のレコードには後続レコードがないことを示します。ステータス コード 8 は、そのメソッドを呼び出す前に、現在のレコード上に位置が確立されていなかったことを示します。

VAccess

現在のインデックス パスの次のレコードを Extended Fetch レコード セットとして取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetNextExtended メソッドの構文は次のような要素で構成されます。

このメソッドはコントロールの ExtendedOps プロパティが False の場合、あるいは AutoMode が True に設定されている場合はまったく効果がありません。

このメソッドは Pervasive PSQL Get Next Extended オペレーションを実行します。その際、コントロールの現在のレコードとインデックス選択を使用して位置を確立し、SelectedRecords プロパティと SelectedFields プロパティに含まれる選択条件を使用します。

コントロールの IncludeCurrent プロパティが True の場合、Extended Fetch オペレーションは現在のレコードから開始します。このプロパティが False の場合、Extended Fetch オペレーションはレコード シーケンスの次のレコードから開始します。Init メソッドは自動的に IncludeCurrent プロパティを True に設定します。GetNextExtended メソッドは、自身が呼び出された後、IncludeCurrent プロパティを False に設定します。

オペレーションが正常に実行されたら、生成されたレコード セット値を Row プロパティと Column プロパティを介して利用できます。オペレーションから返された行数および列数は、Rows プロパティと Columns プロパティで入手できます。また、メソッドから返される Pervasive PSQL ステータス コードは、Status プロパティで入手できます。ゼロ以外のステータス コードが必ずしもレコードが返されなかったことを示すわけではありません。Rows プロパティの値をチェックし、戻された行数を判断してください。

このメソッドを呼び出す前に、任意のレコード選択条件とフィールド選択条件を SelectedRecords プロパティと SelectedFields プロパティに設定し、次に Init メソッドを呼び出して必要な要求バッファー構造体を割り当てることによって、先に Extended Fetch オペレーションのコントロールを設定しておく必要があります。GetFirst や GetGreaterOrEqual などのインデックス付きレコード フェッチ メソッドを使用して、インデックス パスの現在のレコード位置を最初に設定することによって、Extended Fetch オペレーションを最適化することもできます。

VAccess コントロールの Extended オペレーション機能を有効にするには、ExtendedOps プロパティを True に設定する必要があります。

VAccess

現在のインデックス パスの前のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetPrevious メソッドの構文は次のような要素で構成されます。

このメソッドは、IndexNumber プロパティによって設定された、現在選択されているインデックス パスの前のレコードを、そのコントロールに関連付けられたファイルから取得します。

このメソッドを呼び出す前に、インデックス パスに現在の位置を確立しておく必要があります。

オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス コード 9 は、現在のインデックス パスの現在のレコードには後続レコードがないことを示します。ステータス コード 8 は、そのメソッドを呼び出す前に、現在のレコード上に位置が確立されていなかったことを示します。

VAccess

現在のインデックス パスの前のレコードを Extended Fetch レコード セットとして取得し、Pervasive PSQL ステータス コードを整数値で返します。

GetPreviousExtended メソッドの構文は次のような要素で構成されます。

このメソッドは Pervasive PSQL Get Previous Extended オペレーションを実行します。その際、コントロールの現在のレコードとインデックス選択を使用して位置を確立し、SelectedRecords プロパティと SelectedFields プロパティに含まれる選択条件を使用します。

コントロールの IncludeCurrent プロパティが True の場合、Extended Fetch オペレーションは現在のレコードから開始します。このプロパティが False の場合、Extended Fetch オペレーションはレコード シーケンスの次のレコードから開始します。

オペレーションが正常に実行されたら、生成されたレコード セット値を Row プロパティと Column プロパティを介して利用できます。オペレーションから返された行数および列数は、Rows プロパティと Columns プロパティで入手できます。また、メソッドから返される Pervasive PSQL ステータス コードは、Status プロパティで入手できます。

このメソッドを呼び出す前に、任意のレコード選択条件とフィールド選択条件を SelectedRecords プロパティと SelectedFields プロパティに設定し、次に Init メソッドを呼び出して必要な要求バッファー構造体を割り当てることによって、先に Extended Fetch オペレーションのコントロールを設定しておく必要があります。GetLast や GetLessOrEqual などのインデックス付きレコード フェッチ メソッドを使用して、インデックス パスの現在のレコード位置を最初に設定することによって、Extended Fetch オペレーションを最適化することもできます。

このメソッドはコントロールの ExtendedOps プロパティが False の場合、あるいは AutoMode が True に設定されている場合はまったく効果がありません。

VAccess

現在の辞書に定義されているテーブルのリストを 2 次元バリアント配列として返します。

GetTableList メソッドの構文は次のような要素で構成されます。

GetTableList は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

FieldList プロパティは、2 次元バリアント配列をカプセル化するバリアントを受け付けます。あるいはそのバリアントを返します。最初の添字はフィールドの序数を参照し、2 番目の添字はフィールドの 1 つのプロパティを参照します。2 番目の添字が参照するプロパティは次のとおりです。

RefreshLocations プロパティが False の場合は、メモリにキャッシュされた最近のテーブル一覧が返されます。RefreshLocations が True の場合は、辞書から現在のテーブル一覧が再読み取りされます。このメソッドは FieldList や IndexList とは違い、読み取りオペレーションしか行えず、更新は行えません。

FieldList、IndexList、RefreshLocations

VAccess

VAccess コントロールに関連付けられているファイルの、特定のインデックスに含まれるセグメントの総数を返します。

GetTotalSegments は下位互換性を提供するために用意されています。ほとんどの場合、インデックス プロパティは IndexList プロパティを使用して迅速に、しかも簡単に操作できます。

GetTotalSegments メソッドの構文は次のような要素で構成されます。

VAccess

Pervasive PSQL Extended Fetch レコード セット オペレーションを実行する際に使用する構造体を、CacheRows プロパティ、CacheRejectMax プロパティ、SelectedFields プロパティ、および SelectedRecords プロパティから提供されるパラメーターに基づいて強制的に初期化します。

Init は、初期化後 Extended オペレーションを呼び出す前に、あるいは SelectedRecords、SelectedFields、CacheRows、または CacheRejectMax が変更されたときに必ず実行する必要があります。

Init メソッドの構文は次のような要素で構成されます。

AutoMode が True に設定されている場合は、Init メソッドを呼び出すと、最初の Extended Fetch レコード セット オペレーション（GetNextExtended）も実行されます。このオペレーションは論理カレンシーを必要とします。論理カレンシーは、GetFirst、GetEqual などのインデックス付きのレコード オペレーションを呼び出すことによって設定できます。

VAccess コントロールの Extended オペレーション機能を有効にするには、ExtendedOps プロパティを True に設定する必要があります。

VAccess

現在のデータ バッファーを新規レコードとして挿入し、Pervasive PSQL ステータス コードを整数値で返します。

Insert メソッドの構文は次のような要素で構成されます。

このメソッドは object に関連付けられているファイルに現在のデータ バッファーを新規レコードとして挿入し、そのオペレーションの Pervasive PSQL ステータス コードを返します。戻り値がゼロであれば正常に実行されています。戻り値が 5 の場合は、ファイルに定義されている重複値を許可しないキーに対して使用されているデータ バッファー内のフィールドが、ファイルに既存の別のレコードと同じ値を含んでいるため、レコードを挿入できなかったことを示します。

NNC（no-currency-change：カレンシー変更なし）操作を行いたい場合は、KeyNumber プロパティを使用します。

VAccess

コントロールに関連付けられているファイルを開き、Pervasive PSQL ステータス コードを整数値で返します。

Open メソッドの構文は次のような要素で構成されます。

このメソッドは object に関連付けられているファイルを開こうとします。ファイルが既に開いている場合は、先に閉じてから再度開きます。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。

Vaccess、VACombo、VAList

関連オブジェクトを強制的に即時更新します。

VACombo、VAList

フィールド バウンド モードで動作している VAList コントロールまたは VACombo コントロールから項目を削除します。

RemoveItem メソッドの構文は次のような要素で構成されます。

レコード リスト モードで動作している（VARecordList プロパティが True に設定されている）VAList コントロールまたは VACombo コントロールは、RemoveItem メソッドをサポートしません。

VAccess

Extended Fetch レコード セットの中から、指定された Row および Column を基にフィールド値を返します。

RowColumnValue メソッドの構文は次のような要素で構成されます。

このメソッドは、Row プロパティと Column プロパティを使って Extended Fetch レコード セットからフィールド データを取得する方法のショートカットとして使用します。

VAccess コントロールの Extended オペレーション機能を有効にするには、ExtendedOps プロパティを True に設定する必要があります。

VAccess

Create メソッドを使って Btrieve ファイルを作成する前に、指定されたファイル フラグを設定します。

SetFileFlag メソッドの構文は次のような要素で構成されます。

定数宣言は、GLOBAL.BAS ファイル（Visual Basic の場合）、GLOBAL.PAS ファイル（Delphi の場合）および GLOBAL.H ファイル（Visual C++ の場合）に含まれます。アプリケーションでファイル フラグ定数を使用するには、これらのファイルのうち 1 つ、開発環境に適したファイルをプロジェクトに含めます。

VAccess

SetOwner メソッドは、Pervasive PSQL テーブルへのアクセスを制限するために、そのテーブルのオーナー ネームを指定する場合に使用されます。

SetOwner メソッドの構文は次のような要素で構成されます。

次のセキュリティ レベル コードを SetOwner の SecurityLevel パラメーターに渡すことができます。

定数宣言は、GLOBAL.BAS ファイル（16 ビット Visual Basic の場合）、GLOBAL.BAS ファイル（Visual Basic の場合）、GLOBAL.PAS ファイル（Delphi の場合）および GLOBAL.H ファイル（Visual C++ の場合）に含まれます。アプリケーションでセキュリティ レベル定数を使用するには、これらのファイルのうち 1 つ、開発環境に適したファイルをプロジェクトに含めます。

Pervasive PSQL テーブルからオーナー ネームを削除するには、まずそのオーナー ネームでテーブルを開き、次に Btrv メソッドに BTO_ClearOwner オペレーションを発行します。

この値は辞書ファイルにアクセスする際に使用するオーナー ネームには影響しません。一連の辞書ファイルのオーナー ネームを変更する場合は、DdfSetOwner を使用します。

OwnerName、DdfSetOwner、DdfTestOwnerName

VAccess

このメソッドを呼び出すと、［Extended Query Field Selection］（拡張クエリ フィールド選択）ダイアログ ボックスが表示され、ここからユーザーは実行時に SelectedFields プロパティを変更できます。

ShowSelectedFieldsDlg メソッドの構文は次のような要素で構成されます。

Extended Fetch のレコードあるいはフィールド選択基準を変更した後、GetNextExtended などの Extended Fetch メソッドを呼び出す前には、Init メソッドを呼び出す必要があります。

VAccess コントロールの Extended オペレーション機能を有効にするには、ExtendedOps プロパティを True に設定する必要があります。

VAccess

このメソッドを呼び出すと、［Extended Query Record Selection］（拡張クエリ レコード選択）ダイアログ ボックスが表示され、ここからユーザーは実行時に SelectedRecords プロパティを変更できます。

ShowSelectedRecordsDlg メソッドの構文は次のような要素で構成されます。

Extended Fetch のレコードあるいはフィールド選択基準を変更した後、GetNextExtended などの Extended Fetch メソッドを呼び出す前には、Init メソッドを呼び出す必要があります。

VAccess コントロールの Extended オペレーション機能を有効にするには、ExtendedOps プロパティを True に設定する必要があります。

VAccess

現在のテーブルのステータス バッファーを強制的にリフレッシュします。

Stat メソッドの構文は次のような要素で構成されます。

Stat は、VAccess コントロールのステータスを保持する 2 バイトの整数を返します。この値がゼロの場合、オペレーションは正常に終了しています。

Stat はステータス バッファーの更新を強制します。これによって PageSize、TotalKeys、PercentFreeSpace、PreallocatedPages、ReservedDupPointers、ACSName、CollatingSequence、FileVersion などのファイル パラメーターとファイル フラグが更新されます。Stat は、DdfKeyUseIndexDDFOnly が False に設定されている場合は、ステータス バッファーのインデックス情報も更新します。TotalRecords プロパティを取得する前に Stat を呼び出す必要はありません。要求時に TotalRecords が Stat 呼び出しを実行します。

VAccess

このメソッドを呼び出すと、実行時にゼロ以外の数値に設定される場合、タスク モードのメッセージ ボックスが表示されます。一般的な Pervasive PSQL ステータス コードには説明が付きますが、あまり一般的でないステータス コードや認識されないステータス コードは報告されるだけです。

StatusDialog メソッドの構文は次のような要素で構成されます。

VAccess

物理レコードの格納順で最初のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

StepFirst メソッドの構文は次のような要素で構成されます。

このメソッドは、物理レコードが格納されている順で最初のレコードを object に関連付けられたファイルから取得します。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス 9 は、ファイルにレコードがないことを示します。

VAccess

物理レコードの格納順で最後のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

StepLast メソッドの構文は次のような要素で構成されます。

このメソッドは、物理レコードが格納されている順で最後のレコードを object に関連付けられたファイルから取得します。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。ステータス 9 は、ファイルにレコードがないことを示します。

VAccess

物理レコードの格納順で次のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

StepNext メソッドの構文は次のような要素で構成されます。

このメソッドは、物理レコードが格納されている順で次のレコードを object に関連付けられたファイルから取得します。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。戻り値 9 は、ファイルの最後に達したことを示します。戻り値 8 は、このメソッドが呼び出される前に現在のレコード位置が確立されていなかったことを示します。

VAccess

ファイルから物理レコードの格納順で次のレコードを Extended Fetch レコード セットとして取得し、Pervasive PSQL ステータス コードを整数値で返します。

StepNextExtended メソッドの構文は次のような要素で構成されます。

このメソッドは Pervasive PSQL Step Next Extended オペレーションを実行します。その際、現在のレコードを使用して開始位置を確立し、SelectedRecords プロパティと SelectedFields プロパティに含まれる選択条件を使用します。

コントロールの IncludeCurrent プロパティが True の場合、Extended Fetch オペレーションは現在のレコードから開始します。このプロパティが False の場合、Extended Fetch オペレーションはレコード シーケンスの次のレコードから開始します。

オペレーションが正常に実行されたら、生成されたレコード セット値を Row プロパティと Column プロパティを介して利用できます。オペレーションから返された行数および列数は、Rows プロパティと Columns プロパティで入手できます。また、メソッドから返される Pervasive PSQL ステータス コードは、Status プロパティで入手できます。

このメソッドを呼び出す前に、任意のレコード選択条件とフィールド選択条件を SelectedRecords プロパティと SelectedFields プロパティに設定し、次に Init メソッドを呼び出して必要な要求バッファー構造体を割り当てることによって、先に Extended Fetch オペレーションのコントロールを設定しておく必要があります。StepFirst などのシングル レコード フェッチ メソッドを使用して、ファイルの現在のレコード位置を先に設定することもできます。

このメソッドはコントロールの ExtendedOps プロパティが False の場合、あるいは AutoMode が True に設定されている場合はまったく効果がありません。

VAccess

物理レコードの格納順で前のレコードを取得し、Pervasive PSQL ステータス コードを整数値で返します。

StepPrevious メソッドの構文は次のような要素で構成されます。

このメソッドは、物理レコードが格納されている順で前のレコードを object に関連付けられたファイルから取得します。オペレーションのステータス コードはこのメソッドから返され、コントロールの Status プロパティに設定されます。ステータスがゼロの場合は正常に実行されたことを示します。戻り値 9 は、ファイルの最初に達したことを示します。戻り値 8 は、このメソッドが呼び出される前に現在のレコード位置が確立されていなかったことを示します。

VAccess

ファイルから物理レコードの格納順で前のレコードを Extended Fetch レコード セットとして取得し、Pervasive PSQL ステータス コードを整数値で返します。

StepPreviousExtended メソッドの構文は次のような要素で構成されます。

このメソッドは Pervasive PSQL Step Previous Extended オペレーションを実行します。その際、現在のレコードを使用して開始位置を確立し、SelectedRecords プロパティと SelectedFields プロパティに含まれる選択条件を使用します。

コントロールの IncludeCurrent プロパティが True の場合、Extended Fetch オペレーションは現在のレコードから開始します。このプロパティが False の場合、Extended Fetch オペレーションはレコード シーケンスの次のレコードから開始します。

オペレーションが正常に実行されたら、生成されたレコード セット値を Row プロパティと Column プロパティを介して利用できます。オペレーションから返された行数および列数は、Rows プロパティと Columns プロパティで入手できます。また、メソッドから返される Pervasive PSQL ステータス コードは、Status プロパティで入手できます。

このメソッドを呼び出す前に、任意のレコード選択条件とフィールド選択条件を SelectedRecords プロパティと SelectedFields プロパティに設定し、次に Init メソッドを呼び出して必要な要求バッファー構造体を割り当てることによって、先に Extended Fetch オペレーションのコントロールを設定しておく必要があります。StepLast などの単一レコード フェッチ メソッドを使用して、ファイルの現在のレコード位置を先に確立することもできます。

このメソッドはコントロールの ExtendedOps プロパティが False の場合、あるいは AutoMode が True に設定されている場合はまったく効果がありません。

VAccess

Transaction 関数は、アプリケーション内での Pervasive PSQL トランザクション処理を制御します。Pervasive PSQL トランザクションを開始、終了、中止する場合に使用できます。

Transaction メソッドの構文は次のような要素で構成されます。

トランザクション処理は Pervasive PSQL レコード マネージャーのデータ整合性機能です。その目的は、さまざまなテーブルに関連する一連の更新作業において、すべての更新を正常に実行するか、またはすべての更新をロール バックして、参照整合性を確実に保つことです。

Transaction メソッドでサポートされる操作は次のとおりです。ここに挙げられていないオペレーション コードに対してはステータス コード 1、無効なオペレーションが返されます。

定数宣言は、GLOBAL.BAS ファイル（16 ビット Visual Basic の場合）、GLOBAL.BAS ファイル（Visual Basic の場合）、GLOBAL.PAS ファイル（Delphi の場合）および GLOBAL.H ファイル（Visual C++ の場合）に含まれます。アプリケーションで Transaction 定数を使用するには、これらのファイルのうち 1 つ、開発環境に適したファイルをプロジェクトに含めます。

VAccess

Btrv メソッドに渡される Get または Step オペレーション コードにロック バイアス コードを加算することによって Pervasive PSQL テーブルのレコードにセットされた、単一レコード ロックおよび複数レコード ロックを解除します。

Unlock メソッドの構文は次のような要素で構成されます。

Unlock メソッドに渡すことができるロック タイプのコードは次のとおりです。

定数宣言は、GLOBAL.BAS ファイル（16 ビット Visual Basic の場合）、GLOBAL.BAS ファイル（Visual Basic の場合）、GLOBAL.PAS ファイル（Delphi の場合）および GLOBAL.H ファイル（Visual C++ の場合）に含まれます。アプリケーションで Unlock 定数を使用するには、これらのファイルのうち 1 つ、開発環境に適したファイルをプロジェクトに含めます。

VAccess

現在のレコードを現在のデータ バッファーの内容で更新し、Pervasive PSQL ステータス コードを整数値で返します。

Update メソッドの構文は次のような要素で構成されます。

このメソッドは object に関連付けられているファイルの現在のレコードを現在のデータ バッファーの内容で更新し、そのオペレーションの Pervasive PSQL ステータス コードを返します。戻り値がゼロであれば正常に実行されています。

戻り値が 5 の場合は、ファイルに定義されている重複値を許可しないキーに対して使用されているデータ バッファー内のフィールドが、ファイルに既存の別のレコードと同じ値を含んでいるため、レコードを更新できなかったことを示します。戻り値が 80 の場合は、矛盾が発生したことを示します。つまり、そのレコードは読み込まれた時点から Update メソッドが呼び出された時点までの間に、別のプロセスによって更新されているということです。

NNC（no-currency-change：カレンシー変更なし）操作を行いたい場合は、KeyNumber プロパティを使用します。