![]() |
Btrieve 2
|
Btrieve クライアント クラス。 [詳解]
#include <btrieveCpp.h>
公開メンバ関数 | |
BtrieveClient () | |
BtrieveClient (int serviceAgentIdentifier, int clientIdentifier) | |
~BtrieveClient () | |
Btrieve::StatusCode | CollectionClose (BtrieveCollection *btrieveCollection) |
コレクションを閉じます。 | |
Btrieve::StatusCode | CollectionCreate (const char *collectionName) |
コレクションを作成します。 | |
Btrieve::StatusCode | CollectionDelete (const char *collectionName) |
コレクションを削除します。 | |
Btrieve::StatusCode | CollectionOpen (BtrieveCollection *btrieveCollection, const char *collectionName, const char *password=NULL) |
コレクションを開きます。 | |
Btrieve::StatusCode | CollectionRename (const char *existingCollectionName, const char *newCollectionName) |
コレクションの名前を変更します。 | |
Btrieve::StatusCode | ContinuousOperationBegin (const char *pathNames) |
Continuous オペレーションを開始します。 | |
Btrieve::StatusCode | ContinuousOperationBegin (const wchar_t *pathNames) |
Continuous オペレーションを開始します。 | |
Btrieve::StatusCode | ContinuousOperationEnd (const char *pathNames) |
Continuous オペレーションを終了します。 | |
Btrieve::StatusCode | ContinuousOperationEnd (const wchar_t *pathNames) |
Continuous オペレーションを終了します。 | |
Btrieve::StatusCode | FileClose (BtrieveFile *btrieveFile) |
ファイルを閉じます。 | |
Btrieve::StatusCode | FileCreate (BtrieveFileAttributes *btrieveFileAttributes, BtrieveIndexAttributes *btrieveIndexAttributes, const char *fileName, Btrieve::CreateMode createMode, Btrieve::LocationMode locationMode=Btrieve::LOCATION_MODE_NO_PREFERENCE) |
ファイルを作成します。 | |
Btrieve::StatusCode | FileCreate (BtrieveFileAttributes *btrieveFileAttributes, BtrieveIndexAttributes *btrieveIndexAttributes, const wchar_t *fileName, Btrieve::CreateMode createMode, Btrieve::LocationMode locationMode=Btrieve::LOCATION_MODE_NO_PREFERENCE) |
ファイルを作成します。 | |
Btrieve::StatusCode | FileCreate (BtrieveFileAttributes *btrieveFileAttributes, const char *fileName, Btrieve::CreateMode createMode, Btrieve::LocationMode locationMode=Btrieve::LOCATION_MODE_NO_PREFERENCE) |
ファイルを作成します。 | |
Btrieve::StatusCode | FileCreate (BtrieveFileAttributes *btrieveFileAttributes, const wchar_t *fileName, Btrieve::CreateMode createMode, Btrieve::LocationMode locationMode=Btrieve::LOCATION_MODE_NO_PREFERENCE) |
ファイルを作成します。 | |
Btrieve::StatusCode | FileDelete (const char *fileName) |
ファイルを削除します。 | |
Btrieve::StatusCode | FileDelete (const wchar_t *fileName) |
ファイルを削除します。 | |
Btrieve::StatusCode | FileOpen (BtrieveFile *btrieveFile, const char *fileName, const char *ownerName, Btrieve::OpenMode openMode, Btrieve::LocationMode locationMode=Btrieve::LOCATION_MODE_NO_PREFERENCE) |
ファイルを開きます。 | |
Btrieve::StatusCode | FileOpen (BtrieveFile *btrieveFile, const wchar_t *fileName, const char *ownerName, Btrieve::OpenMode openMode, Btrieve::LocationMode locationMode=Btrieve::LOCATION_MODE_NO_PREFERENCE) |
ファイルを開きます。 | |
Btrieve::StatusCode | FileRename (const char *existingFileName, const char *newFileName) |
ファイルの名前を変更します。 | |
Btrieve::StatusCode | FileRename (const wchar_t *existingFileName, const wchar_t *newFileName) |
ファイルの名前を変更します。 | |
int | GetClientIdentifier () |
クライアント ID を取得します。 | |
const char * | GetCurrentDirectory (Btrieve::DiskDrive diskDrive) |
現在のディレクトリを取得します。 | |
Btrieve::StatusCode | GetCurrentDirectory (Btrieve::DiskDrive diskDrive, char *currentDirectory, int currentDirectorySize) |
現在のディレクトリを取得します。 | |
Btrieve::StatusCode | GetCurrentDirectory (Btrieve::DiskDrive diskDrive, wchar_t *currentDirectory, int currentDirectorySize) |
現在のディレクトリを取得します。 | |
Btrieve::StatusCode | GetLastStatusCode () |
最新のステータス コードを取得します。 | |
int | GetServiceAgentIdentifier () |
サービス エージェント ID を取得します。 | |
Btrieve::StatusCode | GetVersion (BtrieveVersion *btrieveVersion, BtrieveFile *btrieveFile=NULL) |
バージョンを取得します。 | |
Btrieve::StatusCode | Login (const char *databaseURI) |
ログインします。 | |
Btrieve::StatusCode | Login (const wchar_t *databaseURI) |
ログインします。 | |
Btrieve::StatusCode | Logout (const char *databaseURI) |
ログアウトします。 | |
Btrieve::StatusCode | Logout (const wchar_t *databaseURI) |
ログアウトします。 | |
Btrieve::StatusCode | Reset () |
リセットします。 | |
Btrieve::StatusCode | SetCurrentDirectory (const char *currentDirectory) |
現在のディレクトリを設定します。 | |
Btrieve::StatusCode | SetCurrentDirectory (const wchar_t *currentDirectory) |
現在のディレクトリを設定します。 | |
Btrieve::StatusCode | Stop () |
停止します。 | |
Btrieve::StatusCode | TransactionAbort () |
トランザクションを中止します。 | |
Btrieve::StatusCode | TransactionBegin (Btrieve::TransactionMode transactionMode, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE) |
トランザクションを開始します。 | |
Btrieve::StatusCode | TransactionEnd () |
トランザクションを終了します。 | |
Btrieve クライアント クラス。
BtrieveClient::BtrieveClient | ( | ) |
BtrieveClient::BtrieveClient | ( | int | serviceAgentIdentifier, |
int | clientIdentifier ) |
[in] | serviceAgentIdentifier | サービス エージェント ID。呼び出し元のプロセス ID を基にサービス エージェント ID を自動的に生成するには、0 を使用します。 |
[in] | clientIdentifier | クライアント ID。呼び出し元のスレッド ID を基にクライアント ID を自動的に生成するには、0 を使用します。 |
BtrieveClient::~BtrieveClient | ( | ) |
Btrieve::StatusCode BtrieveClient::CollectionClose | ( | BtrieveCollection * | btrieveCollection | ) |
コレクションを閉じます。
[in] | btrieveCollection | Btrieve コレクション。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::CollectionCreate | ( | const char * | collectionName | ) |
コレクションを作成します。
[in] | collectionName | コレクション名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::CollectionDelete | ( | const char * | collectionName | ) |
コレクションを削除します。
[in] | collectionName | コレクション名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::CollectionOpen | ( | BtrieveCollection * | btrieveCollection, |
const char * | collectionName, | ||
const char * | password = NULL ) |
コレクションを開きます。
[out] | btrieveCollection | Btrieve コレクション。 |
[in] | collectionName | コレクション名。 |
[in] | password | パスワード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::CollectionRename | ( | const char * | existingCollectionName, |
const char * | newCollectionName ) |
コレクションの名前を変更します。
[in] | existingCollectionName | 既存のコレクション名。 |
[in] | newCollectionName | 新しいコレクション名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::ContinuousOperationBegin | ( | const char * | pathNames | ) |
Continuous オペレーションを開始します。
[in] | pathNames | パス名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::ContinuousOperationBegin | ( | const wchar_t * | pathNames | ) |
Continuous オペレーションを開始します。
[in] | pathNames | パス名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::ContinuousOperationEnd | ( | const char * | pathNames | ) |
Continuous オペレーションを終了します。
[in] | pathNames | パス名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::ContinuousOperationEnd | ( | const wchar_t * | pathNames | ) |
Continuous オペレーションを終了します。
[in] | pathNames | パス名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileClose | ( | BtrieveFile * | btrieveFile | ) |
ファイルを閉じます。
[in] | btrieveFile | Btrieve ファイル。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileCreate | ( | BtrieveFileAttributes * | btrieveFileAttributes, |
BtrieveIndexAttributes * | btrieveIndexAttributes, | ||
const char * | fileName, | ||
Btrieve::CreateMode | createMode, | ||
Btrieve::LocationMode | locationMode = Btrieve::LOCATION_MODE_NO_PREFERENCE ) |
ファイルを作成します。
[in] | btrieveFileAttributes | ファイル属性。 |
[in] | btrieveIndexAttributes | インデックス属性。 |
[in] | fileName | ファイル名。 |
[in] | createMode | 作成モード。 |
[in] | locationMode | 場所モード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileCreate | ( | BtrieveFileAttributes * | btrieveFileAttributes, |
BtrieveIndexAttributes * | btrieveIndexAttributes, | ||
const wchar_t * | fileName, | ||
Btrieve::CreateMode | createMode, | ||
Btrieve::LocationMode | locationMode = Btrieve::LOCATION_MODE_NO_PREFERENCE ) |
ファイルを作成します。
[in] | btrieveFileAttributes | ファイル属性。 |
[in] | btrieveIndexAttributes | インデックス属性。 |
[in] | fileName | ファイル名。 |
[in] | createMode | 作成モード。 |
[in] | locationMode | 場所モード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileCreate | ( | BtrieveFileAttributes * | btrieveFileAttributes, |
const char * | fileName, | ||
Btrieve::CreateMode | createMode, | ||
Btrieve::LocationMode | locationMode = Btrieve::LOCATION_MODE_NO_PREFERENCE ) |
ファイルを作成します。
[in] | btrieveFileAttributes | ファイル属性。 |
[in] | fileName | ファイル名。 |
[in] | createMode | 作成モード。 |
[in] | locationMode | 場所モード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileCreate | ( | BtrieveFileAttributes * | btrieveFileAttributes, |
const wchar_t * | fileName, | ||
Btrieve::CreateMode | createMode, | ||
Btrieve::LocationMode | locationMode = Btrieve::LOCATION_MODE_NO_PREFERENCE ) |
ファイルを作成します。
[in] | btrieveFileAttributes | ファイル属性。 |
[in] | fileName | ファイル名。 |
[in] | createMode | 作成モード。 |
[in] | locationMode | 場所モード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileDelete | ( | const char * | fileName | ) |
ファイルを削除します。
[in] | fileName | ファイル名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileDelete | ( | const wchar_t * | fileName | ) |
ファイルを削除します。
[in] | fileName | ファイル名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileOpen | ( | BtrieveFile * | btrieveFile, |
const char * | fileName, | ||
const char * | ownerName, | ||
Btrieve::OpenMode | openMode, | ||
Btrieve::LocationMode | locationMode = Btrieve::LOCATION_MODE_NO_PREFERENCE ) |
ファイルを開きます。
[out] | btrieveFile | Btrieve ファイル。 |
[in] | fileName | ファイル名。 |
[in] | ownerName | オーナー ネーム。 |
[in] | openMode | オープン モード。 |
[in] | locationMode | 場所モード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileOpen | ( | BtrieveFile * | btrieveFile, |
const wchar_t * | fileName, | ||
const char * | ownerName, | ||
Btrieve::OpenMode | openMode, | ||
Btrieve::LocationMode | locationMode = Btrieve::LOCATION_MODE_NO_PREFERENCE ) |
ファイルを開きます。
[out] | btrieveFile | Btrieve ファイル。 |
[in] | fileName | ファイル名。 |
[in] | ownerName | オーナー ネーム。 |
[in] | openMode | オープン モード。 |
[in] | locationMode | 場所モード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileRename | ( | const char * | existingFileName, |
const char * | newFileName ) |
ファイルの名前を変更します。
[in] | existingFileName | 既存のファイル名。 |
[in] | newFileName | 新しいファイル名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::FileRename | ( | const wchar_t * | existingFileName, |
const wchar_t * | newFileName ) |
ファイルの名前を変更します。
[in] | existingFileName | 既存のファイル名。 |
[in] | newFileName | 新しいファイル名。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
int BtrieveClient::GetClientIdentifier | ( | ) |
クライアント ID を取得します。
>= 0 | クライアント ID。 |
-1 | エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveClient::GetLastStatusCode を使用します。 |
const char * BtrieveClient::GetCurrentDirectory | ( | Btrieve::DiskDrive | diskDrive | ) |
現在のディレクトリを取得します。
[in] | diskDrive | ディスク ドライブ。非 Windows ベースのシステムである場合は DISK_DRIVE_DEFAULT を使用する必要があります。 |
!= NULL | 現在のディレクトリ。 |
NULL | エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveClient::GetLastStatusCode を使用します。 |
Btrieve::StatusCode BtrieveClient::GetCurrentDirectory | ( | Btrieve::DiskDrive | diskDrive, |
char * | currentDirectory, | ||
int | currentDirectorySize ) |
現在のディレクトリを取得します。
[in] | diskDrive | ディスク ドライブ。非 Windows ベースのシステムである場合は DISK_DRIVE_DEFAULT を使用する必要があります。 |
[out] | currentDirectory | 現在のディレクトリ。 |
[in] | currentDirectorySize | 現在のディレクトリのサイズ。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::GetCurrentDirectory | ( | Btrieve::DiskDrive | diskDrive, |
wchar_t * | currentDirectory, | ||
int | currentDirectorySize ) |
現在のディレクトリを取得します。
[in] | diskDrive | ディスク ドライブ。非 Windows ベースのシステムである場合は DISK_DRIVE_DEFAULT を使用する必要があります。 |
[out] | currentDirectory | 現在のディレクトリ。 |
[in] | currentDirectorySize | 現在のディレクトリのサイズ。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::GetLastStatusCode | ( | ) |
最新のステータス コードを取得します。
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
int BtrieveClient::GetServiceAgentIdentifier | ( | ) |
サービス エージェント ID を取得します。
>= 0 | サービス エージェント ID。 |
-1 | エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveClient::GetLastStatusCode を使用します。 |
Btrieve::StatusCode BtrieveClient::GetVersion | ( | BtrieveVersion * | btrieveVersion, |
BtrieveFile * | btrieveFile = NULL ) |
バージョンを取得します。
[out] | btrieveVersion | バージョン。 |
[in] | btrieveFile | Btrieve ファイル。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::Login | ( | const char * | databaseURI | ) |
ログインします。
[in] | databaseURI | データベース URI(uniform resource indicator)。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::Login | ( | const wchar_t * | databaseURI | ) |
ログインします。
[in] | databaseURI | データベース URI(uniform resource indicator)。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::Logout | ( | const char * | databaseURI | ) |
ログアウトします。
[in] | databaseURI | データベース URI(uniform resource indicator)。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::Logout | ( | const wchar_t * | databaseURI | ) |
ログアウトします。
[in] | databaseURI | データベース URI(uniform resource indicator)。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::Reset | ( | ) |
リセットします。
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::SetCurrentDirectory | ( | const char * | currentDirectory | ) |
現在のディレクトリを設定します。
[in] | currentDirectory | 現在のディレクトリ。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::SetCurrentDirectory | ( | const wchar_t * | currentDirectory | ) |
現在のディレクトリを設定します。
[in] | currentDirectory | 現在のディレクトリ。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::Stop | ( | ) |
停止します。
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::TransactionAbort | ( | ) |
トランザクションを中止します。
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::TransactionBegin | ( | Btrieve::TransactionMode | transactionMode, |
Btrieve::LockMode | lockMode = Btrieve::LOCK_MODE_NONE ) |
トランザクションを開始します。
[in] | transactionMode | トランザクション モード。 |
[in] | lockMode | ロック モード。 |
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |
Btrieve::StatusCode BtrieveClient::TransactionEnd | ( | ) |
トランザクションを終了します。
= Btrieve::STATUS_CODE_NO_ERROR | 成功。 |
!= Btrieve::STATUS_CODE_NO_ERROR | エラーが発生しました。 |