Btrieve 2
|
The Btrieve file information class. More...
#include <btrieveCpp.h>
Public Member Functions | |
BtrieveFileInformation () | |
~BtrieveFileInformation () | |
int | GetBalancedIndexes () |
Get balanced indexes. | |
int | GetClientTransactions () |
Get client transactions. | |
int | GetContinuousOperation () |
Get continuous operation. | |
long long | GetDuplicateRecordConflictCursorPosition () |
Get the duplicate record conflict cursor position. | |
Btrieve::Index | GetDuplicateRecordConflictIndex () |
Get the duplicate record conflict index. | |
Btrieve::EncryptType | GetEncryptionType () |
Get the file encryption type. | |
int | GetExplicitLocks () |
Get explicit locks. | |
Btrieve::FileVersion | GetFileVersion () |
Get the file version. | |
int | GetFixedRecordLength () |
Get the fixed record length. | |
Btrieve::FreeSpaceThreshold | GetFreeSpaceThreshold () |
Get the free space threshold. | |
int | GetGatewayMajorVersion () |
Get the gateway major version. | |
int | GetGatewayMinorVersion () |
Get the gateway minor version. | |
const char * | GetGatewayName () |
Get the gateway name. | |
Btrieve::StatusCode | GetGatewayName (char *name, int nameSize) |
Get the gateway name. | |
int | GetGatewayPatchLevel () |
Get the gateway patch level. | |
int | GetGatewayPlatform () |
Get the gateway platform. | |
int | GetHandleCount () |
Get the handle count. | |
int | GetIdentifier () |
Get the identifier. | |
int | GetIndexCount () |
Get the index count. | |
int | GetKeyOnly () |
Get key only. | |
Btrieve::StatusCode | GetKeySegment (BtrieveKeySegment *btrieveKeySegment, int keySegmentNumber) |
Get a key segment. | |
Btrieve::StatusCode | GetLastStatusCode () |
Get the last status code. | |
int | GetLockOwnerClientIdentifier () |
Get the lock owner client identifier. | |
Btrieve::LockMode | GetLockOwnerExplicitLockMode () |
Get the lock owner explcit lock mode. | |
int | GetLockOwnerFileLock () |
Get lock owner file lock. | |
int | GetLockOwnerImplicitLock () |
Get lock owner implicit lock. | |
Btrieve::Index | GetLockOwnerIndex () |
Get the lock owner index. | |
const char * | GetLockOwnerName () |
Get the lock owner name. | |
Btrieve::StatusCode | GetLockOwnerName (char *name, int nameSize) |
Get the lock owner name. | |
Btrieve::PageLockType | GetLockOwnerPageLockType () |
Get the lock owner page lock type. | |
int | GetLockOwnerRecordLock () |
Get lock owner record lock. | |
int | GetLockOwnerSameProcess () |
Get lock owner same process. | |
int | GetLockOwnerServiceAgentIdentifier () |
Get the lock owner service agent identifier. | |
int | GetLockOwnerTimeInTransaction () |
Get the lock owner time in transaction. | |
int | GetLockOwnerTransactionLevel () |
Get the lock owner transaction level. | |
int | GetLockOwnerWriteHold () |
Get lock owner write hold. | |
int | GetLockOwnerWriteNoWait () |
Get lock owner write no wait. | |
int | GetLoggable () |
Get loggable. | |
Btrieve::Index | GetLogIndex () |
Get the log index. | |
int | GetOpenTimestamp () |
Get the open timestamp. | |
Btrieve::OwnerMode | GetOwnerMode () |
Get the owner mode. | |
int | GetPageCompression () |
Get page compression. | |
int | GetPagePreallocation () |
Get page preallocation. | |
Btrieve::PageSize | GetPageSize () |
Get the page size. | |
int | GetReadOnly () |
Get read only. | |
Btrieve::RecordCompressionMode | GetRecordCompressionMode () |
Get the record compression mode. | |
long long | GetRecordCount () |
Get the record count. | |
int | GetReferentialIntegrityConstraints () |
Get referential integrity constraints. | |
long long | GetReferentialIntegrityCursorPosition () |
Get the referential integrity cursor position. | |
const char * | GetReferentialIntegrityFileName () |
Get the referential integrity file name. | |
Btrieve::StatusCode | GetReferentialIntegrityFileName (char *name, int nameSize) |
Get the referential integrity file name. | |
int | GetReferentialIntegrityOperationCode () |
Get the referential integrity operation code. | |
int | GetSecurityCurrentDatabaseAuthenticationByDatabase () |
Get security current database authentication by database. | |
int | GetSecurityCurrentDatabaseAuthorizationByDatabase () |
Get security current database authorization by database. | |
int | GetSecurityCurrentDatabaseBtpasswd () |
Get security current database Btpasswd. | |
int | GetSecurityCurrentDatabaseExplicit () |
Get security current database explicit. | |
int | GetSecurityCurrentDatabaseImplicit () |
Get security current database implicit. | |
const char * | GetSecurityCurrentDatabaseName () |
Get the security current database name. | |
Btrieve::StatusCode | GetSecurityCurrentDatabaseName (char *name, int nameSize) |
Get the security current database name. | |
int | GetSecurityCurrentDatabasePAM () |
Get security current database PAM (Pluggable Authentication Module). | |
int | GetSecurityCurrentDatabaseRTSSComplete () |
Get security current database RTSS (Runtime Server Support) complete. | |
int | GetSecurityCurrentDatabaseRTSSDisabled () |
Get security current database RTSS (Runtime Server Support) disabled. | |
int | GetSecurityCurrentDatabaseRTSSPreauthorized () |
Get security current database RTSS (Runtime Server Support) preauthorized. | |
int | GetSecurityCurrentDatabaseTrusted () |
Get security current database trusted. | |
int | GetSecurityCurrentDatabaseWindowsNamedPipe () |
Get security current database Windows named pipe. | |
int | GetSecurityCurrentDatabaseWorkgroup () |
Get security current database workgroup. | |
const char * | GetSecurityCurrentUserName () |
Get the security current user name. | |
Btrieve::StatusCode | GetSecurityCurrentUserName (char *name, int nameSize) |
Get the security current user name. | |
int | GetSecurityHandleAuthenticationByDatabase () |
Get security handle authentication by database. | |
int | GetSecurityHandleAuthorizationByDatabase () |
Get security handle authorization by database. | |
int | GetSecurityHandleBtpasswd () |
Get security handle Btpasswd. | |
const char * | GetSecurityHandleDatabaseName () |
Get the security handle database name. | |
Btrieve::StatusCode | GetSecurityHandleDatabaseName (char *name, int nameSize) |
Get the security handle database name. | |
int | GetSecurityHandleExplicit () |
Get security handle explicit. | |
int | GetSecurityHandleImplicit () |
Get security handle implicit. | |
int | GetSecurityHandlePAM () |
Get security handle PAM (Pluggable Authentication Module). | |
int | GetSecurityHandleRTSSComplete () |
Get security handle RTSS (Runtime Server Support) complete. | |
int | GetSecurityHandleRTSSDisabled () |
Get security handle RTSS (Runtime Server Support) disabled. | |
int | GetSecurityHandleRTSSPreauthorized () |
Get security handle RTSS (Runtime Server Support) preautorized. | |
const char * | GetSecurityHandleTableName () |
Get the security handle table name. | |
Btrieve::StatusCode | GetSecurityHandleTableName (char *name, int nameSize) |
Get the security handle table name. | |
int | GetSecurityHandleTrusted () |
Get security handle trusted. | |
const char * | GetSecurityHandleUserName () |
Get the security handle user name. | |
Btrieve::StatusCode | GetSecurityHandleUserName (char *name, int nameSize) |
Get the security handle user name. | |
int | GetSecurityHandleWindowsNamedPipe () |
Get security handle Windows named pipe. | |
int | GetSecurityHandleWorkgroup () |
Get security handle workgroup. | |
int | GetSecurityPermissionAlter () |
Get security permission alter. | |
int | GetSecurityPermissionCreateFile () |
Get security permission file create. | |
int | GetSecurityPermissionCreateRecord () |
Get security permission record create. | |
int | GetSecurityPermissionCreateStoredProcedure () |
Get security permission create stored procedure. | |
int | GetSecurityPermissionCreateView () |
Get security permission create view. | |
int | GetSecurityPermissionDelete () |
Get security permission delete. | |
int | GetSecurityPermissionExecute () |
Get security permission execute. | |
int | GetSecurityPermissionNoRights () |
Get security permission no rights. | |
int | GetSecurityPermissionOpen () |
Get security permission open. | |
int | GetSecurityPermissionRead () |
Get security permission read. | |
int | GetSecurityPermissionRefer () |
Get security permission refer. | |
int | GetSecurityPermissionUpdate () |
Get security permission update. | |
int | GetSegmentCount () |
Get the segment count. | |
int | GetSegmented () |
Get segmented. | |
const char * | GetSegmentFileName (int segmentFileNumber) |
Get the segment file name. | |
Btrieve::StatusCode | GetSegmentFileName (int segmentFileNumber, char *name, int nameSize) |
Get the segment file name. | |
int | GetSystemData () |
Get system data. | |
Btrieve::SystemDataMode | GetSystemDataMode () |
Get the system data mode. | |
int | GetSystemIndex () |
Get system index. | |
int | GetSystemIndexSize () |
Get the system index size. | |
int | GetSystemIndexVersion () |
Get the system index version. | |
int | GetUnusedDuplicatePointerCount () |
Get the unused duplicate pointer count. | |
int | GetUnusedPageCount () |
Get the unused page count. | |
int | GetUsageCount () |
Get the usage count. | |
Btrieve::VariableLengthRecordsMode | GetVariableLengthRecordsMode () |
Get the variable length records mode. | |
int | GetWrongOwner () |
Get wrong owner. | |
The Btrieve file information class.
BtrieveFileInformation::BtrieveFileInformation | ( | ) |
BtrieveFileInformation::~BtrieveFileInformation | ( | ) |
int BtrieveFileInformation::GetBalancedIndexes | ( | ) |
Get balanced indexes.
> 0 | Balanced indexes enabled. |
0 | Balanced indexes disabled. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetClientTransactions | ( | ) |
Get client transactions.
> 0 | Client transactions are active. |
0 | Client transactions are not active. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetContinuousOperation | ( | ) |
Get continuous operation.
> 0 | The file is in continuous operation. |
0 | The file isn't in continuous operation. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
long long BtrieveFileInformation::GetDuplicateRecordConflictCursorPosition | ( | ) |
Get the duplicate record conflict cursor position.
>= 0 | The duplicate record conflict cursor position. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::Index BtrieveFileInformation::GetDuplicateRecordConflictIndex | ( | ) |
Get the duplicate record conflict index.
!= Btrieve::INDEX_UNKNOWN | The duplicate record conflict index. |
= Btrieve::INDEX_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::EncryptType BtrieveFileInformation::GetEncryptionType | ( | ) |
Get the file encryption type.
!= Btrieve::ENCRYPT_TYPE_UNKNOWN | The owner mode. |
= Btrieve::ENCRYPT_TYPE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetExplicitLocks | ( | ) |
Get explicit locks.
> 0 | Explicit locks are active. |
0 | Explicit locks are not active. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::FileVersion BtrieveFileInformation::GetFileVersion | ( | ) |
Get the file version.
!= Btrieve::FILE_VERSION_UNKNOWN | The file version. |
= Btrieve::FILE_VERSION_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetFixedRecordLength | ( | ) |
Get the fixed record length.
>= 0 | The fixed record length. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::FreeSpaceThreshold BtrieveFileInformation::GetFreeSpaceThreshold | ( | ) |
Get the free space threshold.
!= Btrieve::FREE_SPACE_THRESHOLD_UNKNOWN | The free space threshold. |
= Btrieve::FREE_SPACE_THRESHOLD_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetGatewayMajorVersion | ( | ) |
Get the gateway major version.
>= 0 | The gateway major version. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetGatewayMinorVersion | ( | ) |
Get the gateway minor version.
>= 0 | The gateway minor version. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetGatewayName | ( | ) |
Get the gateway name.
!= NULL | The name. |
NULL | An error has occurred. |
Btrieve::StatusCode BtrieveFileInformation::GetGatewayName | ( | char * | name, |
int | nameSize ) |
Get the gateway name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetGatewayPatchLevel | ( | ) |
Get the gateway patch level.
>= 0 | The gateway patch version. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetGatewayPlatform | ( | ) |
Get the gateway platform.
>= 0 | The gateway platform. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetHandleCount | ( | ) |
Get the handle count.
>= 0 | The handle count. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetIdentifier | ( | ) |
Get the identifier.
>= 0 | The identifier. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetIndexCount | ( | ) |
Get the index count.
>= 0 | The index count. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetKeyOnly | ( | ) |
Get key only.
> 0 | File is key only. |
0 | File isn't key only. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::StatusCode BtrieveFileInformation::GetKeySegment | ( | BtrieveKeySegment * | btrieveKeySegment, |
int | keySegmentNumber ) |
Get a key segment.
[in] | btrieveKeySegment | The key segment. |
[in] | keySegmentNumber | The key segment number. The number is one-based. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
Btrieve::StatusCode BtrieveFileInformation::GetLastStatusCode | ( | ) |
Get the last status code.
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetLockOwnerClientIdentifier | ( | ) |
Get the lock owner client identifier.
>= 0 | The lock owner client identifier. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::LockMode BtrieveFileInformation::GetLockOwnerExplicitLockMode | ( | ) |
Get the lock owner explcit lock mode.
!= Btrieve::LOCK_MODE_UNKNOWN | The lock owner explcit lock mode. |
= Btrieve::LOCK_MODE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerFileLock | ( | ) |
Get lock owner file lock.
> 0 | The lock owner has a file lock. |
0 | The lock owner doesn't have a file lock. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerImplicitLock | ( | ) |
Get lock owner implicit lock.
> 0 | The lock owner has an implicit lock. |
0 | The lock owner doesn't have an implicit lock. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::Index BtrieveFileInformation::GetLockOwnerIndex | ( | ) |
Get the lock owner index.
!= Btrieve::INDEX_UNKNOWN | The lock owner index. |
= Btrieve::INDEX_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetLockOwnerName | ( | ) |
Get the lock owner name.
!= NULL | The name. |
NULL | An error has occurred. |
Btrieve::StatusCode BtrieveFileInformation::GetLockOwnerName | ( | char * | name, |
int | nameSize ) |
Get the lock owner name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
Btrieve::PageLockType BtrieveFileInformation::GetLockOwnerPageLockType | ( | ) |
Get the lock owner page lock type.
!= Btrieve::PAGE_LOCK_TYPE_UNKNOWN | The lock owner page lock type. |
= Btrieve::PAGE_LOCK_TYPE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerRecordLock | ( | ) |
Get lock owner record lock.
> 0 | The lock owner has a record lock. |
0 | The lock owner doesn't have a record lock. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerSameProcess | ( | ) |
Get lock owner same process.
> 0 | The lock owner is the same process. |
0 | The lock owner isn't the same process. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerServiceAgentIdentifier | ( | ) |
Get the lock owner service agent identifier.
>= 0 | The lock owner service agent identifier. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerTimeInTransaction | ( | ) |
Get the lock owner time in transaction.
>= 0 | The lock owner time in transaction. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerTransactionLevel | ( | ) |
Get the lock owner transaction level.
>= 0 | The lock owner transaction level. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerWriteHold | ( | ) |
Get lock owner write hold.
> 0 | The lock owner has a write hold. |
0 | The lock owner doesn't have a write hold. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLockOwnerWriteNoWait | ( | ) |
Get lock owner write no wait.
> 0 | The lock owner is performing a write with no wait. |
0 | The lock owner isn't performing a write with no wait. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetLoggable | ( | ) |
Get loggable.
> 0 | File is loggable. |
0 | File isn't loggable. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::Index BtrieveFileInformation::GetLogIndex | ( | ) |
Get the log index.
!= Btrieve::INDEX_UNKNOWN | The index. |
= Btrieve::INDEX_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetOpenTimestamp | ( | ) |
Get the open timestamp.
>= 0 | The open timestamp. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::OwnerMode BtrieveFileInformation::GetOwnerMode | ( | ) |
Get the owner mode.
!= Btrieve::OWNER_MODE_UNKNOWN | The owner mode. |
= Btrieve::OWNER_MODE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetPageCompression | ( | ) |
Get page compression.
> 0 | Page compression enabled. |
0 | Page compression disabled. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetPagePreallocation | ( | ) |
Get page preallocation.
> 0 | Page preallocation enabled. |
0 | Page preallocation disabled. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::PageSize BtrieveFileInformation::GetPageSize | ( | ) |
Get the page size.
!= Btrieve::PAGE_SIZE_UNKNOWN | The page size. |
= Btrieve::PAGE_SIZE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetReadOnly | ( | ) |
Get read only.
> 0 | The file is opened read only. |
0 | The file isn't opened read only. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::RecordCompressionMode BtrieveFileInformation::GetRecordCompressionMode | ( | ) |
Get the record compression mode.
!= Btrieve::RECORD_COMPRESSION_MODE_UNKNOWN | Success. |
= Btrieve::RECORD_COMPRESSION_MODE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
long long BtrieveFileInformation::GetRecordCount | ( | ) |
Get the record count.
>= 0 | The record count. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetReferentialIntegrityConstraints | ( | ) |
Get referential integrity constraints.
> 0 | The file has referential integrity constraints. |
0 | The file doesn't have referential integrity constraints. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
long long BtrieveFileInformation::GetReferentialIntegrityCursorPosition | ( | ) |
Get the referential integrity cursor position.
>= 0 | The cursor position. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetReferentialIntegrityFileName | ( | ) |
Get the referential integrity file name.
!= NULL | The name. |
NULL | An error has occurred. |
Btrieve::StatusCode BtrieveFileInformation::GetReferentialIntegrityFileName | ( | char * | name, |
int | nameSize ) |
Get the referential integrity file name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetReferentialIntegrityOperationCode | ( | ) |
Get the referential integrity operation code.
>= 0 | The operation code. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseAuthenticationByDatabase | ( | ) |
Get security current database authentication by database.
> 0 | Security current database authentication by database. |
0 | Security current database not authentication by database. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseAuthorizationByDatabase | ( | ) |
Get security current database authorization by database.
> 0 | Security current database authorization by database. |
0 | Security current database not authorization by database. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseBtpasswd | ( | ) |
Get security current database Btpasswd.
> 0 | Security current database Btpasswd. |
0 | Security current database not Btpasswd. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseExplicit | ( | ) |
Get security current database explicit.
> 0 | Security current database explicit. |
0 | Security current database not explicit. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseImplicit | ( | ) |
Get security current database implicit.
> 0 | Security current database implicit. |
0 | Security current database not implicit. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetSecurityCurrentDatabaseName | ( | ) |
Get the security current database name.
!= NULL | The name. |
NULL | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::StatusCode BtrieveFileInformation::GetSecurityCurrentDatabaseName | ( | char * | name, |
int | nameSize ) |
Get the security current database name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetSecurityCurrentDatabasePAM | ( | ) |
Get security current database PAM (Pluggable Authentication Module).
> 0 | Security current database PAM. |
0 | Security current database not PAM. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSComplete | ( | ) |
Get security current database RTSS (Runtime Server Support) complete.
> 0 | Security current database RTSS complete. |
0 | Security current database not RTSS complete. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSDisabled | ( | ) |
Get security current database RTSS (Runtime Server Support) disabled.
> 0 | Security current database RTSS disabled. |
0 | Security current database not RTSS disabled. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSPreauthorized | ( | ) |
Get security current database RTSS (Runtime Server Support) preauthorized.
> 0 | Security current database RTSS preauthorized. |
0 | Security current database not RTSS preauthorized. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseTrusted | ( | ) |
Get security current database trusted.
> 0 | Security current database trusted. |
0 | Security current database not trusted. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseWindowsNamedPipe | ( | ) |
Get security current database Windows named pipe.
> 0 | Security current database Windows named pipe. |
0 | Security current database not Windows named pipe. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityCurrentDatabaseWorkgroup | ( | ) |
Get security current database workgroup.
> 0 | Security current database workgroup. |
0 | Security current database not workgroup. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetSecurityCurrentUserName | ( | ) |
Get the security current user name.
!= NULL | The name. |
NULL | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::StatusCode BtrieveFileInformation::GetSecurityCurrentUserName | ( | char * | name, |
int | nameSize ) |
Get the security current user name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetSecurityHandleAuthenticationByDatabase | ( | ) |
Get security handle authentication by database.
> 0 | Security handle authentication by database. |
0 | Security handle not authentication by database. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandleAuthorizationByDatabase | ( | ) |
Get security handle authorization by database.
> 0 | Security handle authorization by database. |
0 | Security handle not authorization by database. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandleBtpasswd | ( | ) |
Get security handle Btpasswd.
> 0 | Security handle Btpasswd. |
0 | Security handle not Btpasswd. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetSecurityHandleDatabaseName | ( | ) |
Get the security handle database name.
!= NULL | The name. |
NULL | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::StatusCode BtrieveFileInformation::GetSecurityHandleDatabaseName | ( | char * | name, |
int | nameSize ) |
Get the security handle database name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetSecurityHandleExplicit | ( | ) |
Get security handle explicit.
> 0 | Security handle explicit. |
0 | Security handle not explicit. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandleImplicit | ( | ) |
Get security handle implicit.
> 0 | Security handle implicit. |
0 | Security handle not implicit. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandlePAM | ( | ) |
Get security handle PAM (Pluggable Authentication Module).
> 0 | Security handle PAM. |
0 | Security handle not PAM. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandleRTSSComplete | ( | ) |
Get security handle RTSS (Runtime Server Support) complete.
> 0 | Security handle RTSS complete. |
0 | Security handle not RTSS complete. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandleRTSSDisabled | ( | ) |
Get security handle RTSS (Runtime Server Support) disabled.
> 0 | Security handle RTSS disabled. |
0 | Security handle not RTSS disabled. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandleRTSSPreauthorized | ( | ) |
Get security handle RTSS (Runtime Server Support) preautorized.
> 0 | Security handle RTSS preautorized. |
0 | Security handle not RTSS preautorized. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetSecurityHandleTableName | ( | ) |
Get the security handle table name.
!= NULL | The name. |
NULL | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::StatusCode BtrieveFileInformation::GetSecurityHandleTableName | ( | char * | name, |
int | nameSize ) |
Get the security handle table name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetSecurityHandleTrusted | ( | ) |
Get security handle trusted.
> 0 | Security handle trusted. |
0 | Security handle not trusted. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetSecurityHandleUserName | ( | ) |
Get the security handle user name.
!= NULL | The name. |
NULL | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::StatusCode BtrieveFileInformation::GetSecurityHandleUserName | ( | char * | name, |
int | nameSize ) |
Get the security handle user name.
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetSecurityHandleWindowsNamedPipe | ( | ) |
Get security handle Windows named pipe.
> 0 | Security handle Windows named pipe. |
0 | Security handle not Windows named pipe. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityHandleWorkgroup | ( | ) |
Get security handle workgroup.
> 0 | Security handle workgroup. |
0 | Security handle not workgroup. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionAlter | ( | ) |
Get security permission alter.
> 0 | Security permission alter. |
0 | Security permission no alter. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionCreateFile | ( | ) |
Get security permission file create.
> 0 | Security permission file create. |
0 | Security permission no file create. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionCreateRecord | ( | ) |
Get security permission record create.
> 0 | Security permission record create. |
0 | Security permission no record create. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionCreateStoredProcedure | ( | ) |
Get security permission create stored procedure.
> 0 | Security permission create stored procedure. |
0 | Security permission no create stored procedure. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionCreateView | ( | ) |
Get security permission create view.
> 0 | Security permission create view. |
0 | Security permission no create view. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionDelete | ( | ) |
Get security permission delete.
> 0 | Security permission delete. |
0 | Security permission no delete. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionExecute | ( | ) |
Get security permission execute.
> 0 | Security permission execute. |
0 | Security permission no execute. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionNoRights | ( | ) |
Get security permission no rights.
> 0 | Security permission no rights. |
0 | Security permission rights. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionOpen | ( | ) |
Get security permission open.
> 0 | Security permission open. |
0 | Security permission no open. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionRead | ( | ) |
Get security permission read.
> 0 | Security permission read. |
0 | Security permission no read. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionRefer | ( | ) |
Get security permission refer.
> 0 | Security permission refer. |
0 | Security permission no refer. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSecurityPermissionUpdate | ( | ) |
Get security permission update.
> 0 | Security permission update. |
0 | Security permission no update. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSegmentCount | ( | ) |
Get the segment count.
>= 0 | The exists count. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSegmented | ( | ) |
Get segmented.
> 0 | File is segmented. |
0 | File isn't segmented. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
const char * BtrieveFileInformation::GetSegmentFileName | ( | int | segmentFileNumber | ) |
Get the segment file name.
[in] | segmentFileNumber | The segment file number. |
!= NULL | The name. |
NULL | An error has occurred. |
Btrieve::StatusCode BtrieveFileInformation::GetSegmentFileName | ( | int | segmentFileNumber, |
char * | name, | ||
int | nameSize ) |
Get the segment file name.
[in] | segmentFileNumber | The segment file number. |
[out] | name | The name. |
[in] | nameSize | The name size. |
= Btrieve::STATUS_CODE_NO_ERROR | Success. |
!= Btrieve::STATUS_CODE_NO_ERROR | An error has occurred. |
int BtrieveFileInformation::GetSystemData | ( | ) |
Get system data.
2 | System data version 2 is present. |
1 | System data is present. |
0 | System data isn't present. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::SystemDataMode BtrieveFileInformation::GetSystemDataMode | ( | ) |
Get the system data mode.
!= Btrieve::SYSTEM_DATA_MODE_UNKNOWN | Success. |
= Btrieve::SYSTEM_DATA_MODE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSystemIndex | ( | ) |
Get system index.
3 | System indexes Btrieve::INDEX_SYSTEM and Btrieve::INDEX_SYSTEM_VERSION_2 are present. |
2 | System index Btrieve::INDEX_SYSTEM_VERSION_2 is present. |
1 | System index Btrieve::INDEX_SYSTEM is present. |
0 | No system index is present. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSystemIndexSize | ( | ) |
Get the system index size.
>= 0 | The system index size. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetSystemIndexVersion | ( | ) |
Get the system index version.
>= 0 | The system index version. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetUnusedDuplicatePointerCount | ( | ) |
Get the unused duplicate pointer count.
>= 0 | The unused duplicate pointer count. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetUnusedPageCount | ( | ) |
Get the unused page count.
>= 0 | The unused page count. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetUsageCount | ( | ) |
Get the usage count.
>= 0 | The usage count. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
Btrieve::VariableLengthRecordsMode BtrieveFileInformation::GetVariableLengthRecordsMode | ( | ) |
Get the variable length records mode.
!= Btrieve::SYSTEM_DATA_MODE_UNKNOWN | Success. |
= Btrieve::SYSTEM_DATA_MODE_UNKNOWN | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |
int BtrieveFileInformation::GetWrongOwner | ( | ) |
Get wrong owner.
> 0 | The file was opened with an incorrect owner name. |
0 | The file wasn't opened with an incorrect owner name. |
-1 | An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error. |