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 クライアントクラス。

各種例: Test_BTRV2.cpp, bcollection.cpp, 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 (計15項目).

構築子と解体子

◆ 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] btrieveCollection Btrieve コレクション。

スニペット: C++ bcollection.cpp
// If CollectionClose() fails.

if ((status = btrieveClient->CollectionClose(btrieveCollection)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveClient::CollectionClose():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bcollection.py
rc = btrieveClient.CollectionClose(btrieveCollection)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::CollectionClose():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照: Btrieve::StatusCodeToString

各種例: bcollection.cpp.

◆ CollectionCreate()

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

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

引数

[in] collectionName コレクション名。

スニペット: C++ bcollection.cpp
// If CollectionCreate() fails.

if ((status = btrieveClient->CollectionCreate(btrieveCollectionName)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveClient::CollectionCreate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bcollection.py
rc = btrieveClient.CollectionCreate(btrieveCollectionName)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::CollectionCreate():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照: Btrieve::StatusCodeToString

各種例: bcollection.cpp.

◆ CollectionDelete()

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

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

引数

[in] collectionName コレクション名。

スニペット: C++ bcollection.cpp
// If CollectionDelete() fails.

if ((status = btrieveClient->CollectionDelete(btrieveCollectionName)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveClient::CollectionDelete():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bcollection.py
rc = btrieveClient.CollectionDelete(btrieveCollectionName)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::CollectionDelete():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照: Btrieve::StatusCodeToString

各種例: bcollection.cpp.

◆ CollectionOpen()

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

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

引数

[out]	btrieveCollection	Btrieve コレクション。
[in]	collectionName	コレクション名。
[in]	password	パスワード。

スニペット: C++ bcollection.cpp
// If CollectionOpen() fails.

if ((status = btrieveClient->CollectionOpen(btrieveCollection, btrieveCollectionName)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveClient::CollectionOpen():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bcollection.py
rc = btrieveClient.CollectionOpen(btrieveCollection, btrieveCollectionName)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::CollectionOpen():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照: Btrieve::StatusCodeToString

各種例: bcollection.cpp.

◆ 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] btrieveFile Btrieve ファイル。

スニペット: 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

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

◆ FileCreate() [1/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	場所モード。

スニペット: 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() [2/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	場所モード。

スニペット: 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() [3/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

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

◆ FileCreate() [4/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

◆ 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]	btrieveFile	Btrieve ファイル。
[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

各種例: Test_BTRV2.cpp, bfileattributes.cpp, bfileinformation.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.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]	btrieveFile	Btrieve ファイル。
[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]	btrieveFile	Btrieve ファイル。

スニペット: C++ bversion.cpp
// 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;

}

Python bversion.py
rc = btrieveClient.GetVersion(btrieveVersion)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::GetVersion():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

= 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）。

スニペット: C++ bversion.cpp
// 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;

}

Python bversion.py
rc = btrieveClient.Login(databaseURI)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::Login():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

= 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）。

スニペット: C++ bversion.cpp
// 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;

}

Python bversion.py
rc = btrieveClient.Logout(databaseURI)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::Logout():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

= 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

公開メンバ関数

詳解

構築子と解体子

◆ BtrieveClient() [1/2]

◆ BtrieveClient() [2/2]

◆ ~BtrieveClient()

関数詳解

◆ CollectionClose()

◆ CollectionCreate()

◆ CollectionDelete()

◆ CollectionOpen()

◆ CollectionRename()

◆ ContinuousOperationBegin() [1/2]

◆ ContinuousOperationBegin() [2/2]

◆ ContinuousOperationEnd() [1/2]

◆ ContinuousOperationEnd() [2/2]

◆ FileClose()

◆ FileCreate() [1/4]

◆ FileCreate() [2/4]

◆ FileCreate() [3/4]

◆ FileCreate() [4/4]

◆ FileDelete() [1/2]

◆ FileDelete() [2/2]

◆ FileOpen() [1/2]

◆ FileOpen() [2/2]

◆ FileRename() [1/2]

◆ FileRename() [2/2]

◆ GetClientIdentifier()

◆ GetCurrentDirectory() [1/3]

◆ GetCurrentDirectory() [2/3]

◆ GetCurrentDirectory() [3/3]

◆ GetLastStatusCode()

◆ GetServiceAgentIdentifier()

◆ GetVersion()

◆ Login() [1/2]

◆ Login() [2/2]

◆ Logout() [1/2]

◆ Logout() [2/2]

◆ Reset()

◆ SetCurrentDirectory() [1/2]

◆ SetCurrentDirectory() [2/2]

◆ Stop()

◆ TransactionAbort()

◆ TransactionBegin()

◆ TransactionEnd()