公開メンバ関数 | 全メンバ一覧
BtrieveClient クラス

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, const char *fileName, Btrieve::CreateMode createMode, Btrieve::LocationMode locationMode=Btrieve::LOCATION_MODE_NO_PREFERENCE)
 ファイルを作成します。 [詳解]
 
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, const wchar_t *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 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 クライアント クラス。

各種例:
bfileattributes.cpp, bfileinformation.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp, bversion.cpp, Test_BTRV2.cpp.

構築子と解体子

◆ BtrieveClient() [1/2]

BtrieveClient::BtrieveClient ( )
サービス エージェント ID およびクライアント ID は、呼び出し元のプロセス ID およびスレッド ID を基に自動的に生成されます。

◆ BtrieveClient() [2/2]

BtrieveClient::BtrieveClient ( int  serviceAgentIdentifier,
int  clientIdentifier 
)
引数
[in]serviceAgentIdentifierサービス エージェント ID。呼び出し元のプロセス ID を基にサービス エージェント ID を自動的に生成するには、0 を使用します。
[in]clientIdentifierクライアント ID。呼び出し元のスレッド ID を基にクライアント ID を自動的に生成するには、0 を使用します。
スニペット
C++ btest.cpp
BtrieveClient btrieveClient;
Python btest.py
btrieveClient = btrievePython.BtrieveClient()
assert(btrieveClient != None)

◆ ~BtrieveClient()

BtrieveClient::~BtrieveClient ( )

関数詳解

◆ CollectionClose()

Btrieve::StatusCode BtrieveClient::CollectionClose ( BtrieveCollection *  btrieveCollection)

コレクションを閉じます。

引数
[in]btrieveCollectionBtrieve コレクション。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ CollectionCreate()

Btrieve::StatusCode BtrieveClient::CollectionCreate ( const char *  collectionName)

コレクションを作成します。

引数
[in]collectionNameコレクション名。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ CollectionDelete()

Btrieve::StatusCode BtrieveClient::CollectionDelete ( const char *  collectionName)

コレクションを削除します。

引数
[in]collectionNameコレクション名。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ CollectionOpen()

Btrieve::StatusCode BtrieveClient::CollectionOpen ( BtrieveCollection *  btrieveCollection,
const char *  collectionName,
const char *  password = NULL 
)

コレクションを開きます。

引数
[out]btrieveCollectionBtrieve コレクション。
[in]collectionNameコレクション名。
[in]passwordパスワード。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ CollectionRename()

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::StatusCodeToString

◆ ContinuousOperationBegin() [1/2]

Btrieve::StatusCode BtrieveClient::ContinuousOperationBegin ( const char *  pathNames)

Continuous オペレーションを開始します。

引数
[in]pathNamesパス名。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ ContinuousOperationBegin() [2/2]

Btrieve::StatusCode BtrieveClient::ContinuousOperationBegin ( const wchar_t *  pathNames)

Continuous オペレーションを開始します。

引数
[in]pathNamesパス名。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ ContinuousOperationEnd() [1/2]

Btrieve::StatusCode BtrieveClient::ContinuousOperationEnd ( const char *  pathNames)

Continuous オペレーションを終了します。

引数
[in]pathNamesパス名。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ ContinuousOperationEnd() [2/2]

Btrieve::StatusCode BtrieveClient::ContinuousOperationEnd ( const wchar_t *  pathNames)

Continuous オペレーションを終了します。

引数
[in]pathNamesパス名。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ FileClose()

Btrieve::StatusCode BtrieveClient::FileClose ( BtrieveFile *  btrieveFile)

ファイルを閉じます。

引数
[in]btrieveFileBtrieve ファイル。
スニペット
C++ btest.cpp
// If FileClose() fails.
if ((status = btrieveClient->FileClose(btrieveFile)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileClose():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileClose(btrieveFile)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileClose():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bfileattributes.cpp, bfileinformation.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp, Test_BTRV2.cpp.

◆ FileCreate() [1/4]

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場所モード。
スニペット
C++ btest.cpp
// If FileCreate() fails.
if ((status = btrieveClient->FileCreate(&btrieveFileAttributes, btrieveFileName, Btrieve::CREATE_MODE_OVERWRITE)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileCreate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileCreate(btrieveFileAttributes, btrieveFileName, btrievePython.Btrieve.CREATE_MODE_OVERWRITE)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileCreate():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bfileattributes.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp, Test_BTRV2.cpp.

◆ FileCreate() [2/4]

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::StatusCodeToString

◆ FileCreate() [3/4]

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場所モード。
スニペット
C++ btest.cpp
// If FileCreate() fails.
if ((status = btrieveClient->FileCreate(&btrieveFileAttributes, btrieveFileName, Btrieve::CREATE_MODE_OVERWRITE)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileCreate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileCreate(btrieveFileAttributes, btrieveFileName, btrievePython.Btrieve.CREATE_MODE_OVERWRITE)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileCreate():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ FileCreate() [4/4]

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::StatusCodeToString

◆ FileDelete() [1/2]

Btrieve::StatusCode BtrieveClient::FileDelete ( const char *  fileName)

ファイルを削除します。

引数
[in]fileNameファイル名。
スニペット
C++ btest.cpp
// If FileDelete() fails.
if ((status = btrieveClient->FileDelete(btrieveFileName)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileDelete():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileDelete(btrieveFileName)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileDelete():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bfileattributes.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp.

◆ FileDelete() [2/2]

Btrieve::StatusCode BtrieveClient::FileDelete ( const wchar_t *  fileName)

ファイルを削除します。

引数
[in]fileNameファイル名。
スニペット
C++ btest.cpp
// If FileDelete() fails.
if ((status = btrieveClient->FileDelete(btrieveFileName)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileDelete():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileDelete(btrieveFileName)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileDelete():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ FileOpen() [1/2]

Btrieve::StatusCode BtrieveClient::FileOpen ( BtrieveFile *  btrieveFile,
const char *  fileName,
const char *  ownerName,
Btrieve::OpenMode  openMode,
Btrieve::LocationMode  locationMode = Btrieve::LOCATION_MODE_NO_PREFERENCE 
)

ファイルを開きます。

引数
[out]btrieveFileBtrieve ファイル。
[in]fileNameファイル名。
[in]ownerNameオーナー ネーム。
[in]openModeオープン モード。
[in]locationMode場所モード。
スニペット
C++ btest.cpp
// If FileOpen() fails.
if ((status = btrieveClient->FileOpen(btrieveFile, btrieveFileName, NULL, Btrieve::OPEN_MODE_NORMAL)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileOpen():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileOpen(btrieveFile, btrieveFileName, None, btrievePython.Btrieve.OPEN_MODE_NORMAL)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileOpen():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bfileattributes.cpp, bfileinformation.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp, Test_BTRV2.cpp.

◆ FileOpen() [2/2]

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]btrieveFileBtrieve ファイル。
[in]fileNameファイル名。
[in]ownerNameオーナー ネーム。
[in]openModeオープン モード。
[in]locationMode場所モード。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ FileRename() [1/2]

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::StatusCodeToString

◆ FileRename() [2/2]

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エラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ GetClientIdentifier()

int BtrieveClient::GetClientIdentifier ( )

クライアント ID を取得します。

戻り値
>= 0クライアント ID。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveClient::GetLastStatusCode を使用します。

◆ GetCurrentDirectory() [1/3]

const char* BtrieveClient::GetCurrentDirectory ( Btrieve::DiskDrive  diskDrive)

現在のディレクトリを取得します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]diskDriveディスク ドライブ。非 Windows ベースのシステムである場合は DISK_DRIVE_DEFAULT を使用する必要があります。
戻り値
!= NULL現在のディレクトリ。
NULLエラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveClient::GetLastStatusCode を使用します。

◆ GetCurrentDirectory() [2/3]

Btrieve::StatusCode BtrieveClient::GetCurrentDirectory ( Btrieve::DiskDrive  diskDrive,
char *  currentDirectory,
int  currentDirectorySize 
)

現在のディレクトリを取得します。

覚え書き
このメソッドは C++ でのみ使用可能です。
引数
[in]diskDriveディスク ドライブ。非 Windows ベースのシステムである場合は DISK_DRIVE_DEFAULT を使用する必要があります。
[out]currentDirectory現在のディレクトリ。
[in]currentDirectorySize現在のディレクトリのサイズ。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ GetCurrentDirectory() [3/3]

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::StatusCodeToString

◆ GetLastStatusCode()

Btrieve::StatusCode BtrieveClient::GetLastStatusCode ( )

最新のステータス コードを取得します。

覚え書き
このメソッドは、ステータス コードを返さない以下のメソッドでの使用を目的としています。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ GetServiceAgentIdentifier()

int BtrieveClient::GetServiceAgentIdentifier ( )

サービス エージェント ID を取得します。

戻り値
>= 0サービス エージェント ID。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveClient::GetLastStatusCode を使用します。

◆ GetVersion()

Btrieve::StatusCode BtrieveClient::GetVersion ( BtrieveVersion *  btrieveVersion,
BtrieveFile *  btrieveFile = NULL 
)

バージョンを取得します。

引数
[out]btrieveVersionバージョン。
[in]btrieveFileBtrieve ファイル。
スニペット
// If GetVersion() fails.
if ((status = btrieveClient->GetVersion(&btrieveVersion)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::GetVersion():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bversion.cpp.

◆ Login() [1/2]

Btrieve::StatusCode BtrieveClient::Login ( const char *  databaseURI)

ログインします。

引数
[in]databaseURIデータベース URI（uniform resource indicator）。
スニペット
// If Login() fails.
if ((status = btrieveClient->Login(databaseURI)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::Login():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bversion.cpp.

◆ Login() [2/2]

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::StatusCodeToString

◆ Logout() [1/2]

Btrieve::StatusCode BtrieveClient::Logout ( const char *  databaseURI)

ログアウトします。

引数
[in]databaseURIデータベース URI（uniform resource indicator）。
スニペット
// If Logout() fails.
if ((status = btrieveClient->Logout(databaseURI)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::Logout():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bversion.cpp.

◆ Logout() [2/2]

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::StatusCodeToString

◆ Reset()

Btrieve::StatusCode BtrieveClient::Reset ( )

リセットします。

戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ SetCurrentDirectory() [1/2]

Btrieve::StatusCode BtrieveClient::SetCurrentDirectory ( const char *  currentDirectory)

現在のディレクトリを設定します。

引数
[in]currentDirectory現在のディレクトリ。
説明
現在のディレクトリは、デフォルトで現在の作業ディレクトリになります。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ SetCurrentDirectory() [2/2]

Btrieve::StatusCode BtrieveClient::SetCurrentDirectory ( const wchar_t *  currentDirectory)

現在のディレクトリを設定します。

引数
[in]currentDirectory現在のディレクトリ。
説明
現在のディレクトリは、デフォルトで現在の作業ディレクトリになります。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ Stop()

Btrieve::StatusCode BtrieveClient::Stop ( )

停止します。

戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ TransactionAbort()

Btrieve::StatusCode BtrieveClient::TransactionAbort ( )

トランザクションを中止します。

戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ TransactionBegin()

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::StatusCodeToString

◆ TransactionEnd()

Btrieve::StatusCode BtrieveClient::TransactionEnd ( )

トランザクションを終了します。

戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
2023年10月31日(火) 11時57分57秒作成 / 構成:   doxygen 1.8.13