Public Member Functions | List of all members
BtrieveFileInformation Class Reference

The Btrieve file information class. More...

#include <btrieveCpp.h>

Public Member Functions

 BtrieveFileInformation ()
 
 ~BtrieveFileInformation ()
 
int GetBalancedIndexes ()
 Get balanced indexes. More...
 
int GetClientTransactions ()
 Get client transactions. More...
 
int GetContinuousOperation ()
 Get continuous operation. More...
 
long long GetDuplicateRecordConflictCursorPosition ()
 Get the duplicate record conflict cursor position. More...
 
Btrieve::Index GetDuplicateRecordConflictIndex ()
 Get the duplicate record conflict index. More...
 
Btrieve::EncryptType GetEncryptionType ()
 Get the file encryption type. More...
 
int GetExplicitLocks ()
 Get explicit locks. More...
 
Btrieve::FileVersion GetFileVersion ()
 Get the file version. More...
 
int GetFixedRecordLength ()
 Get the fixed record length. More...
 
Btrieve::FreeSpaceThreshold GetFreeSpaceThreshold ()
 Get the free space threshold. More...
 
int GetGatewayMajorVersion ()
 Get the gateway major version. More...
 
int GetGatewayMinorVersion ()
 Get the gateway minor version. More...
 
const char * GetGatewayName ()
 Get the gateway name. More...
 
Btrieve::StatusCode GetGatewayName (char *name, int nameSize)
 Get the gateway name. More...
 
int GetGatewayPatchLevel ()
 Get the gateway patch level. More...
 
int GetGatewayPlatform ()
 Get the gateway platform. More...
 
int GetHandleCount ()
 Get the handle count. More...
 
int GetIdentifier ()
 Get the identifier. More...
 
int GetIndexCount ()
 Get the index count. More...
 
int GetKeyOnly ()
 Get key only. More...
 
Btrieve::StatusCode GetKeySegment (BtrieveKeySegment *btrieveKeySegment, int keySegmentNumber)
 Get a key segment. More...
 
Btrieve::StatusCode GetLastStatusCode ()
 Get the last status code. More...
 
int GetLockOwnerClientIdentifier ()
 Get the lock owner client identifier. More...
 
Btrieve::LockMode GetLockOwnerExplicitLockMode ()
 Get the lock owner explcit lock mode. More...
 
int GetLockOwnerFileLock ()
 Get lock owner file lock. More...
 
int GetLockOwnerImplicitLock ()
 Get lock owner implicit lock. More...
 
Btrieve::Index GetLockOwnerIndex ()
 Get the lock owner index. More...
 
const char * GetLockOwnerName ()
 Get the lock owner name. More...
 
Btrieve::StatusCode GetLockOwnerName (char *name, int nameSize)
 Get the lock owner name. More...
 
Btrieve::PageLockType GetLockOwnerPageLockType ()
 Get the lock owner page lock type. More...
 
int GetLockOwnerRecordLock ()
 Get lock owner record lock. More...
 
int GetLockOwnerSameProcess ()
 Get lock owner same process. More...
 
int GetLockOwnerServiceAgentIdentifier ()
 Get the lock owner service agent identifier. More...
 
int GetLockOwnerTimeInTransaction ()
 Get the lock owner time in transaction. More...
 
int GetLockOwnerTransactionLevel ()
 Get the lock owner transaction level. More...
 
int GetLockOwnerWriteHold ()
 Get lock owner write hold. More...
 
int GetLockOwnerWriteNoWait ()
 Get lock owner write no wait. More...
 
int GetLoggable ()
 Get loggable. More...
 
Btrieve::Index GetLogIndex ()
 Get the log index. More...
 
int GetOpenTimestamp ()
 Get the open timestamp. More...
 
Btrieve::OwnerMode GetOwnerMode ()
 Get the owner mode. More...
 
int GetPageCompression ()
 Get page compression. More...
 
int GetPagePreallocation ()
 Get page preallocation. More...
 
Btrieve::PageSize GetPageSize ()
 Get the page size. More...
 
int GetReadOnly ()
 Get read only. More...
 
Btrieve::RecordCompressionMode GetRecordCompressionMode ()
 Get the record compression mode. More...
 
long long GetRecordCount ()
 Get the record count. More...
 
int GetReferentialIntegrityConstraints ()
 Get referential integrity constraints. More...
 
long long GetReferentialIntegrityCursorPosition ()
 Get the referential integrity cursor position. More...
 
const char * GetReferentialIntegrityFileName ()
 Get the referential integrity file name. More...
 
Btrieve::StatusCode GetReferentialIntegrityFileName (char *name, int nameSize)
 Get the referential integrity file name. More...
 
int GetReferentialIntegrityOperationCode ()
 Get the referential integrity operation code. More...
 
int GetSecurityCurrentDatabaseAuthenticationByDatabase ()
 Get security current database authentication by database. More...
 
int GetSecurityCurrentDatabaseAuthorizationByDatabase ()
 Get security current database authorization by database. More...
 
int GetSecurityCurrentDatabaseBtpasswd ()
 Get security current database Btpasswd. More...
 
int GetSecurityCurrentDatabaseExplicit ()
 Get security current database explicit. More...
 
int GetSecurityCurrentDatabaseImplicit ()
 Get security current database implicit. More...
 
const char * GetSecurityCurrentDatabaseName ()
 Get the security current database name. More...
 
Btrieve::StatusCode GetSecurityCurrentDatabaseName (char *name, int nameSize)
 Get the security current database name. More...
 
int GetSecurityCurrentDatabasePAM ()
 Get security current database PAM (Pluggable Authentication Module). More...
 
int GetSecurityCurrentDatabaseRTSSComplete ()
 Get security current database RTSS (Runtime Server Support) complete. More...
 
int GetSecurityCurrentDatabaseRTSSDisabled ()
 Get security current database RTSS (Runtime Server Support) disabled. More...
 
int GetSecurityCurrentDatabaseRTSSPreauthorized ()
 Get security current database RTSS (Runtime Server Support) preauthorized. More...
 
int GetSecurityCurrentDatabaseTrusted ()
 Get security current database trusted. More...
 
int GetSecurityCurrentDatabaseWindowsNamedPipe ()
 Get security current database Windows named pipe. More...
 
int GetSecurityCurrentDatabaseWorkgroup ()
 Get security current database workgroup. More...
 
const char * GetSecurityCurrentUserName ()
 Get the security current user name. More...
 
Btrieve::StatusCode GetSecurityCurrentUserName (char *name, int nameSize)
 Get the security current user name. More...
 
int GetSecurityHandleAuthenticationByDatabase ()
 Get security handle authentication by database. More...
 
int GetSecurityHandleAuthorizationByDatabase ()
 Get security handle authorization by database. More...
 
int GetSecurityHandleBtpasswd ()
 Get security handle Btpasswd. More...
 
const char * GetSecurityHandleDatabaseName ()
 Get the security handle database name. More...
 
Btrieve::StatusCode GetSecurityHandleDatabaseName (char *name, int nameSize)
 Get the security handle database name. More...
 
int GetSecurityHandleExplicit ()
 Get security handle explicit. More...
 
int GetSecurityHandleImplicit ()
 Get security handle implicit. More...
 
int GetSecurityHandlePAM ()
 Get security handle PAM (Pluggable Authentication Module). More...
 
int GetSecurityHandleRTSSComplete ()
 Get security handle RTSS (Runtime Server Support) complete. More...
 
int GetSecurityHandleRTSSDisabled ()
 Get security handle RTSS (Runtime Server Support) disabled. More...
 
int GetSecurityHandleRTSSPreauthorized ()
 Get security handle RTSS (Runtime Server Support) preautorized. More...
 
const char * GetSecurityHandleTableName ()
 Get the security handle table name. More...
 
Btrieve::StatusCode GetSecurityHandleTableName (char *name, int nameSize)
 Get the security handle table name. More...
 
int GetSecurityHandleTrusted ()
 Get security handle trusted. More...
 
const char * GetSecurityHandleUserName ()
 Get the security handle user name. More...
 
Btrieve::StatusCode GetSecurityHandleUserName (char *name, int nameSize)
 Get the security handle user name. More...
 
int GetSecurityHandleWindowsNamedPipe ()
 Get security handle Windows named pipe. More...
 
int GetSecurityHandleWorkgroup ()
 Get security handle workgroup. More...
 
int GetSecurityPermissionAlter ()
 Get security permission alter. More...
 
int GetSecurityPermissionCreateFile ()
 Get security permission file create. More...
 
int GetSecurityPermissionCreateRecord ()
 Get security permission record create. More...
 
int GetSecurityPermissionCreateStoredProcedure ()
 Get security permission create stored procedure. More...
 
int GetSecurityPermissionCreateView ()
 Get security permission create view. More...
 
int GetSecurityPermissionDelete ()
 Get security permission delete. More...
 
int GetSecurityPermissionExecute ()
 Get security permission execute. More...
 
int GetSecurityPermissionNoRights ()
 Get security permission no rights. More...
 
int GetSecurityPermissionOpen ()
 Get security permission open. More...
 
int GetSecurityPermissionRead ()
 Get security permission read. More...
 
int GetSecurityPermissionRefer ()
 Get security permission refer. More...
 
int GetSecurityPermissionUpdate ()
 Get security permission update. More...
 
int GetSegmentCount ()
 Get the segment count. More...
 
int GetSegmented ()
 Get segmented. More...
 
const char * GetSegmentFileName (int segmentFileNumber)
 Get the segment file name. More...
 
Btrieve::StatusCode GetSegmentFileName (int segmentFileNumber, char *name, int nameSize)
 Get the segment file name. More...
 
Btrieve::SystemDataMode GetSystemDataMode ()
 Get the system data mode. More...
 
int GetSystemIndexPresent ()
 Get system index present. More...
 
int GetSystemIndexSize ()
 Get the system index size. More...
 
int GetSystemIndexUsed ()
 Get system index used. More...
 
int GetSystemIndexVersion ()
 Get the system index version. More...
 
int GetUnusedDuplicatePointerCount ()
 Get the unused duplicate pointer count. More...
 
int GetUnusedPageCount ()
 Get the unused page count. More...
 
int GetUsageCount ()
 Get the usage count. More...
 
Btrieve::VariableLengthRecordsMode GetVariableLengthRecordsMode ()
 Get the variable length records mode. More...
 
int GetWrongOwner ()
 Get wrong owner. More...
 

Detailed Description

The Btrieve file information class.

Examples:
bfileattributes.cpp, and bfileinformation.cpp.

Constructor & Destructor Documentation

◆ BtrieveFileInformation()

BtrieveFileInformation::BtrieveFileInformation ( )
Snippet
BtrieveFileInformation btrieveFileInformation;
See also
BtrieveFile::GetInformation

◆ ~BtrieveFileInformation()

BtrieveFileInformation::~BtrieveFileInformation ( )

Member Function Documentation

◆ GetBalancedIndexes()

int BtrieveFileInformation::GetBalancedIndexes ( )

Get balanced indexes.

Snippet
// If GetBalancedIndexes() fails.
if ((i = btrieveFileInformation.GetBalancedIndexes()) == Btrieve::INDEX_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetBalancedIndexes():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("BalancedIndexes = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Balanced indexes enabled.
0Balanced indexes disabled.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetClientTransactions()

int BtrieveFileInformation::GetClientTransactions ( )

Get client transactions.

Snippet
// If GetClientTransactions() fails.
if ((i = btrieveFileInformation.GetClientTransactions()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetClientTransactions():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ClientTransactions = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Client transactions are active.
0Client transactions are not active.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetContinuousOperation()

int BtrieveFileInformation::GetContinuousOperation ( )

Get continuous operation.

Snippet
// If GetContinuousOperation() fails.
if ((i = btrieveFileInformation.GetContinuousOperation()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetContinuousOperation():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ContinuousOperation = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The file is in continuous operation.
0The file isn't in continuous operation.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetDuplicateRecordConflictCursorPosition()

long long BtrieveFileInformation::GetDuplicateRecordConflictCursorPosition ( )

Get the duplicate record conflict cursor position.

Note
The signature for this method changed in PSQL 13.20.
Snippet
// If GetDuplicateRecordConflictCursorPosition() fails.
if ((cursorPosition = btrieveFileInformation.GetDuplicateRecordConflictCursorPosition()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetDuplicateRecordConflictCursorPosition():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("DuplicateRecordConflictCursorPosition = %lld\n", cursorPosition);
Return values
>= 0The duplicate record conflict cursor position.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetDuplicateRecordConflictIndex()

Btrieve::Index BtrieveFileInformation::GetDuplicateRecordConflictIndex ( )

Get the duplicate record conflict index.

Snippet
// If GetDuplicateRecordConflictIndex() fails.
if ((btrieveIndex = btrieveFileInformation.GetDuplicateRecordConflictIndex()) == Btrieve::INDEX_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetDuplicateRecordConflictIndex():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("DuplicateRecordConflictIndex = %s\n", Btrieve::IndexToString(btrieveIndex));
Return values
!= Btrieve::INDEX_UNKNOWNThe duplicate record conflict index.
= Btrieve::INDEX_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::IndexToString
Examples:
bfileinformation.cpp.

◆ GetEncryptionType()

Btrieve::EncryptType BtrieveFileInformation::GetEncryptionType ( )

Get the file encryption type.

Return values
!= Btrieve::ENCRYPT_TYPE_UNKNOWNThe owner mode.
= Btrieve::ENCRYPT_TYPE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::EncryptTypeToString

◆ GetExplicitLocks()

int BtrieveFileInformation::GetExplicitLocks ( )

Get explicit locks.

Snippet
// If GetExplicitLocks() fails.
if ((i = btrieveFileInformation.GetExplicitLocks()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetExplicitLocks():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ExplicitLocks = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Explicit locks are active.
0Explicit locks are not active.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetFileVersion()

Btrieve::FileVersion BtrieveFileInformation::GetFileVersion ( )

Get the file version.

Snippet
// If GetFileVersion() fails.
if ((btrieveFileVersion = btrieveFileInformation.GetFileVersion()) == Btrieve::FILE_VERSION_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetFileVersion():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("FileVersion = %s\n", Btrieve::FileVersionToString(btrieveFileVersion));
Return values
!= Btrieve::FILE_VERSION_UNKNOWNThe file version.
= Btrieve::FILE_VERSION_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::FileVersionToString
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetFixedRecordLength()

int BtrieveFileInformation::GetFixedRecordLength ( )

Get the fixed record length.

Snippet
// If GetFixedRecordLength() fails.
if ((i = btrieveFileInformation.GetFixedRecordLength()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetFixedRecordLength():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("FixedRecordLength = %d\n", i);
Return values
>= 0The fixed record length.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetFreeSpaceThreshold()

Btrieve::FreeSpaceThreshold BtrieveFileInformation::GetFreeSpaceThreshold ( )

Get the free space threshold.

Snippet
// If GetFreeSpaceThreshold() fails.
if ((btrieveFreeSpaceThreshold = btrieveFileInformation.GetFreeSpaceThreshold()) == Btrieve::FREE_SPACE_THRESHOLD_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetFreeSpaceThreshold():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("FreeSpaceThreshold = %s\n", Btrieve::FreeSpaceThresholdToString(btrieveFreeSpaceThreshold));
Return values
!= Btrieve::FREE_SPACE_THRESHOLD_UNKNOWNThe free space threshold.
= Btrieve::FREE_SPACE_THRESHOLD_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::FreeSpaceThresholdToString
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetGatewayMajorVersion()

int BtrieveFileInformation::GetGatewayMajorVersion ( )

Get the gateway major version.

Snippet
// If GetGatewayMajorVersion() fails.
if ((i = btrieveFileInformation.GetGatewayMajorVersion()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetGatewayMajorVersion():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("GatewayMajorVersion = %d\n", i);
Return values
>= 0The gateway major version.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetGatewayMinorVersion()

int BtrieveFileInformation::GetGatewayMinorVersion ( )

Get the gateway minor version.

Snippet
// If GetGatewayMinorVersion() fails.
if ((i = btrieveFileInformation.GetGatewayMinorVersion()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetGatewayMinorVersion():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("GatewayMinorVersion = %d\n", i);
Return values
>= 0The gateway minor version.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetGatewayName() [1/2]

const char* BtrieveFileInformation::GetGatewayName ( )

Get the gateway name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetGatewayName() fails.
if ((c = btrieveFileInformation.GetGatewayName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetGatewayName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("GatewayName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred.
Examples:
bfileinformation.cpp.

◆ GetGatewayName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetGatewayName ( char *  name,
int  nameSize 
)

Get the gateway name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetGatewayPatchLevel()

int BtrieveFileInformation::GetGatewayPatchLevel ( )

Get the gateway patch level.

Snippet
// If GetGatewayPatchLevel() fails.
if ((i = btrieveFileInformation.GetGatewayPatchLevel()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetGatewayPatchLevel():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("GatewayPatchLevel = %d\n", i);
Return values
>= 0The gateway patch version.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetGatewayPlatform()

int BtrieveFileInformation::GetGatewayPlatform ( )

Get the gateway platform.

Snippet
// If GetGatewayPlatform() fails.
if ((i = btrieveFileInformation.GetGatewayPlatform()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetGatewayPlatform():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("GatewayPlatform = %d\n", i);
Return values
>= 0The gateway platform.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetHandleCount()

int BtrieveFileInformation::GetHandleCount ( )

Get the handle count.

Snippet
// If GetHandleCount() fails.
if ((i = btrieveFileInformation.GetHandleCount()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetHandleCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("HandleCount = %d\n", i);
Return values
>= 0The handle count.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetIdentifier()

int BtrieveFileInformation::GetIdentifier ( )

Get the identifier.

Snippet
// If GetIdentifier() fails.
if ((i = btrieveFileInformation.GetIdentifier()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetIdentifier():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("Identifier = %d\n", i);
Return values
>= 0The identifier.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetIndexCount()

int BtrieveFileInformation::GetIndexCount ( )

Get the index count.

Snippet
// If GetIndexCount() fails.
if ((indexCount = btrieveFileInformation.GetIndexCount()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetIndexCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("IndexCount = %d\n", indexCount);
Return values
>= 0The index count.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetKeyOnly()

int BtrieveFileInformation::GetKeyOnly ( )

Get key only.

Snippet
// If GetKeyOnly() fails.
if ((i = btrieveFileInformation.GetKeyOnly()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetKeyOnly():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("KeyOnly = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0File is key only.
0File isn't key only.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetKeySegment()

Btrieve::StatusCode BtrieveFileInformation::GetKeySegment ( BtrieveKeySegment btrieveKeySegment,
int  keySegmentNumber 
)

Get a key segment.

Parameters
[in]btrieveKeySegmentThe key segment.
[in]keySegmentNumberThe key segment number. The number is one-based.
Snippet
// If GetKeySegment() fails.
if ((status = btrieveFileInformation.GetKeySegment(&btrieveKeySegment, keySegmentNumber)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileInformation::GetKeySegment():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString
Examples:
bfileinformation.cpp.

◆ GetLastStatusCode()

Btrieve::StatusCode BtrieveFileInformation::GetLastStatusCode ( )

Get the last status code.

Note
This method is intended for use following methods which don't return a status code.
Snippet
// If GetBalancedIndexes() fails.
if ((i = btrieveFileInformation.GetBalancedIndexes()) == Btrieve::INDEX_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetBalancedIndexes():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetLockOwnerClientIdentifier()

int BtrieveFileInformation::GetLockOwnerClientIdentifier ( )

Get the lock owner client identifier.

Snippet
// If GetLockOwnerClientIdentifier() fails.
if ((i = btrieveFileInformation.GetLockOwnerClientIdentifier()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerClientIdentifier():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerClientIdentifier = %d\n", i);
Return values
>= 0The lock owner client identifier.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerExplicitLockMode()

Btrieve::LockMode BtrieveFileInformation::GetLockOwnerExplicitLockMode ( )

Get the lock owner explcit lock mode.

Snippet
// If GetLockOwnerExplicitLockMode() fails.
if ((btrieveLockMode = btrieveFileInformation.GetLockOwnerExplicitLockMode()) == Btrieve::LOCK_MODE_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerExplicitLockMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerExplicitLockMode = %s\n", Btrieve::LockModeToString(btrieveLockMode));
Return values
!= Btrieve::LOCK_MODE_UNKNOWNThe lock owner explcit lock mode.
= Btrieve::LOCK_MODE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::LockModeToString
Examples:
bfileinformation.cpp.

◆ GetLockOwnerFileLock()

int BtrieveFileInformation::GetLockOwnerFileLock ( )

Get lock owner file lock.

Snippet
// If GetLockOwnerFileLock() fails.
if ((i = btrieveFileInformation.GetLockOwnerFileLock()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerFileLock():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerFileLock = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The lock owner has a file lock.
0The lock owner doesn't have a file lock.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerImplicitLock()

int BtrieveFileInformation::GetLockOwnerImplicitLock ( )

Get lock owner implicit lock.

Snippet
// If GetLockOwnerImplicitLock() fails.
if ((i = btrieveFileInformation.GetLockOwnerImplicitLock()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerImplicitLock():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerImplicitLock = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The lock owner has an implicit lock.
0The lock owner doesn't have an implicit lock.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerIndex()

Btrieve::Index BtrieveFileInformation::GetLockOwnerIndex ( )

Get the lock owner index.

Snippet
// If GetLockOwnerIndex() fails.
if ((btrieveIndex = btrieveFileInformation.GetLockOwnerIndex()) == Btrieve::INDEX_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerIndex():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerIndex = %s\n", Btrieve::IndexToString(btrieveIndex));
Return values
!= Btrieve::INDEX_UNKNOWNThe lock owner index.
= Btrieve::INDEX_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::IndexToString
Examples:
bfileinformation.cpp.

◆ GetLockOwnerName() [1/2]

const char* BtrieveFileInformation::GetLockOwnerName ( )

Get the lock owner name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetLockOwnerName() fails.
if ((c = btrieveFileInformation.GetLockOwnerName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetLockOwnerName ( char *  name,
int  nameSize 
)

Get the lock owner name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetLockOwnerPageLockType()

Btrieve::PageLockType BtrieveFileInformation::GetLockOwnerPageLockType ( )

Get the lock owner page lock type.

Snippet
// If GetLockOwnerPageLockType() fails.
if ((btrievePageLockType = btrieveFileInformation.GetLockOwnerPageLockType()) == Btrieve::PAGE_LOCK_TYPE_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerPageLockType():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerPageLockType = %s\n", Btrieve::PageLockTypeToString(btrievePageLockType));
Return values
!= Btrieve::PAGE_LOCK_TYPE_UNKNOWNThe lock owner page lock type.
= Btrieve::PAGE_LOCK_TYPE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::PageLockTypeToString
Examples:
bfileinformation.cpp.

◆ GetLockOwnerRecordLock()

int BtrieveFileInformation::GetLockOwnerRecordLock ( )

Get lock owner record lock.

Snippet
// If GetLockOwnerRecordLock() fails.
if ((i = btrieveFileInformation.GetLockOwnerRecordLock()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerRecordLock():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerRecordLock = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The lock owner has a record lock.
0The lock owner doesn't have a record lock.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerSameProcess()

int BtrieveFileInformation::GetLockOwnerSameProcess ( )

Get lock owner same process.

Snippet
// If GetLockOwnerSameProcess() fails.
if ((i = btrieveFileInformation.GetLockOwnerSameProcess()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerSameProcess():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerSameProcess = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The lock owner is the same process.
0The lock owner isn't the same process.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerServiceAgentIdentifier()

int BtrieveFileInformation::GetLockOwnerServiceAgentIdentifier ( )

Get the lock owner service agent identifier.

Snippet
// If GetLockOwnerServiceAgentIdentifier() fails.
if ((i = btrieveFileInformation.GetLockOwnerServiceAgentIdentifier()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerServiceAgentIdentifier():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerServiceAgentIdentifier = %d\n", i);
Return values
>= 0The lock owner service agent identifier.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerTimeInTransaction()

int BtrieveFileInformation::GetLockOwnerTimeInTransaction ( )

Get the lock owner time in transaction.

Snippet
// If GetLockOwnerTimeInTransaction() fails.
if ((i = btrieveFileInformation.GetLockOwnerTimeInTransaction()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerTimeInTransaction():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerTimeInTransaction = %d\n", i);
Return values
>= 0The lock owner time in transaction.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerTransactionLevel()

int BtrieveFileInformation::GetLockOwnerTransactionLevel ( )

Get the lock owner transaction level.

Snippet
// If GetLockOwnerTransactionLevel() fails.
if ((i = btrieveFileInformation.GetLockOwnerTransactionLevel()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerTransactionLevel():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerTransactionLevel = %d\n", i);
Return values
>= 0The lock owner transaction level.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerWriteHold()

int BtrieveFileInformation::GetLockOwnerWriteHold ( )

Get lock owner write hold.

Snippet
// If GetLockOwnerWriteHold() fails.
if ((i = btrieveFileInformation.GetLockOwnerWriteHold()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerWriteHold():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerWriteHold = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The lock owner has a write hold.
0The lock owner doesn't have a write hold.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLockOwnerWriteNoWait()

int BtrieveFileInformation::GetLockOwnerWriteNoWait ( )

Get lock owner write no wait.

Snippet
// If GetLockOwnerWriteNoWait() fails.
if ((i = btrieveFileInformation.GetLockOwnerWriteNoWait()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLockOwnerWriteNoWait():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LockOwnerWriteNoWait = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The lock owner is performing a write with no wait.
0The lock owner isn't performing a write with no wait.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLoggable()

int BtrieveFileInformation::GetLoggable ( )

Get loggable.

Snippet
// If GetLoggable() fails.
if ((i = btrieveFileInformation.GetLoggable()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLoggable():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("Loggable = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0File is loggable.
0File isn't loggable.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetLogIndex()

Btrieve::Index BtrieveFileInformation::GetLogIndex ( )

Get the log index.

Snippet
// If GetLogIndex() fails.
if ((btrieveIndex = btrieveFileInformation.GetLogIndex()) == Btrieve::INDEX_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetLogIndex():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("LogIndex = %s\n", Btrieve::IndexToString(btrieveIndex));
Return values
!= Btrieve::INDEX_UNKNOWNThe index.
= Btrieve::INDEX_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::IndexToString
Examples:
bfileinformation.cpp.

◆ GetOpenTimestamp()

int BtrieveFileInformation::GetOpenTimestamp ( )

Get the open timestamp.

Snippet
// If GetOpenTimestamp() fails.
if ((i = btrieveFileInformation.GetOpenTimestamp()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetOpenTimestamp():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("OpenTimestamp = %d\n", i);
Return values
>= 0The open timestamp.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetOwnerMode()

Btrieve::OwnerMode BtrieveFileInformation::GetOwnerMode ( )

Get the owner mode.

Snippet
// If GetOwnerMode() fails.
if ((btrieveOwnerMode = btrieveFileInformation.GetOwnerMode()) == Btrieve::OWNER_MODE_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetOwnerMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("OwnerMode = %s\n", Btrieve::OwnerModeToString(btrieveOwnerMode));
Return values
!= Btrieve::OWNER_MODE_UNKNOWNThe owner mode.
= Btrieve::OWNER_MODE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::OwnerModeToString
Examples:
bfileinformation.cpp.

◆ GetPageCompression()

int BtrieveFileInformation::GetPageCompression ( )

Get page compression.

Snippet
// If GetPageCompression() fails.
if ((i = btrieveFileInformation.GetPageCompression()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetPageCompression():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("PageCompression = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Page compression enabled.
0Page compression disabled.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetPagePreallocation()

int BtrieveFileInformation::GetPagePreallocation ( )

Get page preallocation.

Snippet
// If GetPagePreallocation() fails.
if ((i = btrieveFileInformation.GetPagePreallocation()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetPagePreallocation():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("PagePreallocation = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Page preallocation enabled.
0Page preallocation disabled.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetPageSize()

Btrieve::PageSize BtrieveFileInformation::GetPageSize ( )

Get the page size.

Snippet
// If GetPageSize() fails.
if ((btrievePageSize = btrieveFileInformation.GetPageSize()) == Btrieve::PAGE_SIZE_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetPageSize():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("PageSize = %s\n", Btrieve::PageSizeToString(btrievePageSize));
Return values
!= Btrieve::PAGE_SIZE_UNKNOWNThe page size.
= Btrieve::PAGE_SIZE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::PageSizeToString
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetReadOnly()

int BtrieveFileInformation::GetReadOnly ( )

Get read only.

Snippet
// If GetReadOnly() fails.
if ((i = btrieveFileInformation.GetReadOnly()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetReadOnly():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ReadOnly = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The file is opened read only.
0The file isn't opened read only.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetRecordCompressionMode()

Btrieve::RecordCompressionMode BtrieveFileInformation::GetRecordCompressionMode ( )

Get the record compression mode.

Snippet
// If GetRecordCompressionMode() fails.
if ((btrieveRecordCompressionMode = btrieveFileInformation.GetRecordCompressionMode()) == Btrieve::RECORD_COMPRESSION_MODE_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetRecordCompressionMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("RecordCompressionMode = %s\n", Btrieve::RecordCompressionModeToString(btrieveRecordCompressionMode));
Return values
!= Btrieve::RECORD_COMPRESSION_MODE_UNKNOWNSuccess.
= Btrieve::RECORD_COMPRESSION_MODE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::RecordCompressionModeToString
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetRecordCount()

long long BtrieveFileInformation::GetRecordCount ( )

Get the record count.

Note
The signature for this method changed in PSQL 13.20.
Snippet
// If GetRecordCount() fails.
if ((recordCount = btrieveFileInformation.GetRecordCount()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetRecordCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("RecordCount = %lld\n", recordCount);
Return values
>= 0The record count.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetReferentialIntegrityConstraints()

int BtrieveFileInformation::GetReferentialIntegrityConstraints ( )

Get referential integrity constraints.

Snippet
// If GetReferentialIntegrityConstraints() fails.
if ((i = btrieveFileInformation.GetReferentialIntegrityConstraints()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetReferentialIntegrityConstraints():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ReferentialIntegrityConstraints = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The file has referential integrity constraints.
0The file doesn't have referential integrity constraints.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetReferentialIntegrityCursorPosition()

long long BtrieveFileInformation::GetReferentialIntegrityCursorPosition ( )

Get the referential integrity cursor position.

Note
The signature for this method changed in PSQL 13.20.
Snippet
// If GetReferentialIntegrityCursorPosition() fails.
if ((cursorPosition = btrieveFileInformation.GetReferentialIntegrityCursorPosition()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetReferentialIntegrityCursorPosition():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ReferentialIntegrityCursorPosition = %lld\n", cursorPosition);
Return values
>= 0The cursor position.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetReferentialIntegrityFileName() [1/2]

const char* BtrieveFileInformation::GetReferentialIntegrityFileName ( )

Get the referential integrity file name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetReferentialIntegrityFileName() fails.
if ((c = btrieveFileInformation.GetReferentialIntegrityFileName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetReferentialIntegrityFileName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ReferentialIntegrityFileName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred.
Examples:
bfileinformation.cpp.

◆ GetReferentialIntegrityFileName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetReferentialIntegrityFileName ( char *  name,
int  nameSize 
)

Get the referential integrity file name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetReferentialIntegrityOperationCode()

int BtrieveFileInformation::GetReferentialIntegrityOperationCode ( )

Get the referential integrity operation code.

Snippet
// If GetReferentialIntegrityOperationCode() fails.
if ((i = btrieveFileInformation.GetReferentialIntegrityOperationCode()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetReferentialIntegrityOperationCode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("ReferentialIntegrityOperationCode = %d\n", i);
Return values
>= 0The operation code.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseAuthenticationByDatabase()

int BtrieveFileInformation::GetSecurityCurrentDatabaseAuthenticationByDatabase ( )

Get security current database authentication by database.

Snippet
// If GetSecurityCurrentDatabaseAuthenticationByDatabase() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseAuthenticationByDatabase()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseAuthenticationByDatabase():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseAuthenticationByDatabase = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database authentication by database.
0Security current database not authentication by database.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseAuthorizationByDatabase()

int BtrieveFileInformation::GetSecurityCurrentDatabaseAuthorizationByDatabase ( )

Get security current database authorization by database.

Snippet
// If GetSecurityCurrentDatabaseAuthorizationByDatabase() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseAuthorizationByDatabase()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseAuthorizationByDatabase():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseAuthorizationByDatabase = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database authorization by database.
0Security current database not authorization by database.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseBtpasswd()

int BtrieveFileInformation::GetSecurityCurrentDatabaseBtpasswd ( )

Get security current database Btpasswd.

Snippet
// If GetSecurityCurrentDatabaseBtpasswd() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseBtpasswd()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseBtpasswd():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseBtpasswd = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database Btpasswd.
0Security current database not Btpasswd.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseExplicit()

int BtrieveFileInformation::GetSecurityCurrentDatabaseExplicit ( )

Get security current database explicit.

Snippet
// If GetSecurityCurrentDatabaseExplicit() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseExplicit()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseExplicit():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseExplicit = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database explicit.
0Security current database not explicit.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseImplicit()

int BtrieveFileInformation::GetSecurityCurrentDatabaseImplicit ( )

Get security current database implicit.

Snippet
// If GetSecurityCurrentDatabaseImplicit() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseImplicit()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseImplicit():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseImplicit = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database implicit.
0Security current database not implicit.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseName() [1/2]

const char* BtrieveFileInformation::GetSecurityCurrentDatabaseName ( )

Get the security current database name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetSecurityCurrentDatabaseName() fails.
if ((c = btrieveFileInformation.GetSecurityCurrentDatabaseName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetSecurityCurrentDatabaseName ( char *  name,
int  nameSize 
)

Get the security current database name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetSecurityCurrentDatabasePAM()

int BtrieveFileInformation::GetSecurityCurrentDatabasePAM ( )

Get security current database PAM (Pluggable Authentication Module).

Snippet
// If GetSecurityCurrentDatabasePAM() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabasePAM()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabasePAM():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabasePAM = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database PAM.
0Security current database not PAM.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseRTSSComplete()

int BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSComplete ( )

Get security current database RTSS (Runtime Server Support) complete.

Snippet
// If GetSecurityCurrentDatabaseRTSSComplete() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseRTSSComplete()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSComplete():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseRTSSComplete = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database RTSS complete.
0Security current database not RTSS complete.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseRTSSDisabled()

int BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSDisabled ( )

Get security current database RTSS (Runtime Server Support) disabled.

Snippet
// If GetSecurityCurrentDatabaseRTSSDisabled() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseRTSSDisabled()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSDisabled():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseRTSSDisabled = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database RTSS disabled.
0Security current database not RTSS disabled.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseRTSSPreauthorized()

int BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSPreauthorized ( )

Get security current database RTSS (Runtime Server Support) preauthorized.

Snippet
// If GetSecurityCurrentDatabaseRTSSPreauthorized() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseRTSSPreauthorized()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseRTSSPreauthorized():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseRTSSPreauthorized = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database RTSS preauthorized.
0Security current database not RTSS preauthorized.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseTrusted()

int BtrieveFileInformation::GetSecurityCurrentDatabaseTrusted ( )

Get security current database trusted.

Snippet
// If GetSecurityCurrentDatabaseTrusted() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseTrusted()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseTrusted():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseTrusted = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database trusted.
0Security current database not trusted.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseWindowsNamedPipe()

int BtrieveFileInformation::GetSecurityCurrentDatabaseWindowsNamedPipe ( )

Get security current database Windows named pipe.

Snippet
// If GetSecurityCurrentDatabaseWindowsNamedPipe() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseWindowsNamedPipe()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseWindowsNamedPipe():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseWindowsNamedPipe = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database Windows named pipe.
0Security current database not Windows named pipe.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentDatabaseWorkgroup()

int BtrieveFileInformation::GetSecurityCurrentDatabaseWorkgroup ( )

Get security current database workgroup.

Snippet
// If GetSecurityCurrentDatabaseWorkgroup() fails.
if ((i = btrieveFileInformation.GetSecurityCurrentDatabaseWorkgroup()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentDatabaseWorkgroup():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentDatabaseWorkgroup = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security current database workgroup.
0Security current database not workgroup.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentUserName() [1/2]

const char* BtrieveFileInformation::GetSecurityCurrentUserName ( )

Get the security current user name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetSecurityCurrentUserName() fails.
if ((c = btrieveFileInformation.GetSecurityCurrentUserName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityCurrentUserName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityCurrentUserName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityCurrentUserName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetSecurityCurrentUserName ( char *  name,
int  nameSize 
)

Get the security current user name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetSecurityHandleAuthenticationByDatabase()

int BtrieveFileInformation::GetSecurityHandleAuthenticationByDatabase ( )

Get security handle authentication by database.

Snippet
// If GetSecurityHandleAuthenticationByDatabase() fails.
if ((i = btrieveFileInformation.GetSecurityHandleAuthenticationByDatabase()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleAuthenticationByDatabase():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleAuthenticationByDatabase = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle authentication by database.
0Security handle not authentication by database.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleAuthorizationByDatabase()

int BtrieveFileInformation::GetSecurityHandleAuthorizationByDatabase ( )

Get security handle authorization by database.

Snippet
// If GetSecurityHandleAuthorizationByDatabase() fails.
if ((i = btrieveFileInformation.GetSecurityHandleAuthorizationByDatabase()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleAuthorizationByDatabase():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleAuthorizationByDatabase = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle authorization by database.
0Security handle not authorization by database.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleBtpasswd()

int BtrieveFileInformation::GetSecurityHandleBtpasswd ( )

Get security handle Btpasswd.

Snippet
// If GetSecurityHandleBtpasswd() fails.
if ((i = btrieveFileInformation.GetSecurityHandleBtpasswd()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleBtpasswd():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleBtpasswd = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle Btpasswd.
0Security handle not Btpasswd.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleDatabaseName() [1/2]

const char* BtrieveFileInformation::GetSecurityHandleDatabaseName ( )

Get the security handle database name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetSecurityHandleDatabaseName() fails.
if ((c = btrieveFileInformation.GetSecurityHandleDatabaseName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleDatabaseName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleDatabaseName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleDatabaseName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetSecurityHandleDatabaseName ( char *  name,
int  nameSize 
)

Get the security handle database name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetSecurityHandleExplicit()

int BtrieveFileInformation::GetSecurityHandleExplicit ( )

Get security handle explicit.

Snippet
// If GetSecurityHandleExplicit() fails.
if ((i = btrieveFileInformation.GetSecurityHandleExplicit()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleExplicit():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleExplicit = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle explicit.
0Security handle not explicit.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleImplicit()

int BtrieveFileInformation::GetSecurityHandleImplicit ( )

Get security handle implicit.

Snippet
// If GetSecurityHandleImplicit() fails.
if ((i = btrieveFileInformation.GetSecurityHandleImplicit()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleImplicit():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleImplicit = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle implicit.
0Security handle not implicit.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandlePAM()

int BtrieveFileInformation::GetSecurityHandlePAM ( )

Get security handle PAM (Pluggable Authentication Module).

Snippet
// If GetSecurityHandlePAM() fails.
if ((i = btrieveFileInformation.GetSecurityHandlePAM()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandlePAM():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandlePAM = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle PAM.
0Security handle not PAM.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleRTSSComplete()

int BtrieveFileInformation::GetSecurityHandleRTSSComplete ( )

Get security handle RTSS (Runtime Server Support) complete.

Snippet
// If GetSecurityHandleRTSSComplete() fails.
if ((i = btrieveFileInformation.GetSecurityHandleRTSSComplete()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleRTSSComplete():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleRTSSComplete = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle RTSS complete.
0Security handle not RTSS complete.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleRTSSDisabled()

int BtrieveFileInformation::GetSecurityHandleRTSSDisabled ( )

Get security handle RTSS (Runtime Server Support) disabled.

Snippet
// If GetSecurityHandleRTSSDisabled() fails.
if ((i = btrieveFileInformation.GetSecurityHandleRTSSDisabled()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleRTSSDisabled():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleRTSSDisabled = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle RTSS disabled.
0Security handle not RTSS disabled.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleRTSSPreauthorized()

int BtrieveFileInformation::GetSecurityHandleRTSSPreauthorized ( )

Get security handle RTSS (Runtime Server Support) preautorized.

Snippet
// If GetSecurityHandleRTSSPreauthorized() fails.
if ((i = btrieveFileInformation.GetSecurityHandleRTSSPreauthorized()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleRTSSPreauthorized():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleRTSSPreauthorized = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle RTSS preautorized.
0Security handle not RTSS preautorized.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleTableName() [1/2]

const char* BtrieveFileInformation::GetSecurityHandleTableName ( )

Get the security handle table name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetSecurityHandleTableName() fails.
if ((c = btrieveFileInformation.GetSecurityHandleTableName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleTableName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleTableName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleTableName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetSecurityHandleTableName ( char *  name,
int  nameSize 
)

Get the security handle table name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetSecurityHandleTrusted()

int BtrieveFileInformation::GetSecurityHandleTrusted ( )

Get security handle trusted.

Snippet
// If GetSecurityHandleTrusted() fails.
if ((i = btrieveFileInformation.GetSecurityHandleTrusted()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleTrusted():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleTrusted = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle trusted.
0Security handle not trusted.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleUserName() [1/2]

const char* BtrieveFileInformation::GetSecurityHandleUserName ( )

Get the security handle user name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Snippet
// If GetSecurityHandleUserName() fails.
if ((c = btrieveFileInformation.GetSecurityHandleUserName()) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleUserName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleUserName = %s\n", c);
Return values
!= NULLThe name.
NULLAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleUserName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetSecurityHandleUserName ( char *  name,
int  nameSize 
)

Get the security handle user name.

Note
The method is available only in C++.
Parameters
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetSecurityHandleWindowsNamedPipe()

int BtrieveFileInformation::GetSecurityHandleWindowsNamedPipe ( )

Get security handle Windows named pipe.

Snippet
// If GetSecurityHandleWindowsNamedPipe() fails.
if ((i = btrieveFileInformation.GetSecurityHandleWindowsNamedPipe()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleWindowsNamedPipe():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleWindowsNamedPipe = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle Windows named pipe.
0Security handle not Windows named pipe.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityHandleWorkgroup()

int BtrieveFileInformation::GetSecurityHandleWorkgroup ( )

Get security handle workgroup.

Snippet
// If GetSecurityHandleWorkgroup() fails.
if ((i = btrieveFileInformation.GetSecurityHandleWorkgroup()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityHandleWorkgroup():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityHandleWorkgroup = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security handle workgroup.
0Security handle not workgroup.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionAlter()

int BtrieveFileInformation::GetSecurityPermissionAlter ( )

Get security permission alter.

Snippet
// If GetSecurityPermissionAlter() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionAlter()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionAlter():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionAlter = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission alter.
0Security permission no alter.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionCreateFile()

int BtrieveFileInformation::GetSecurityPermissionCreateFile ( )

Get security permission file create.

Snippet
// If GetSecurityPermissionCreateFile() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionCreateFile()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionCreateFile():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionCreateFile = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission file create.
0Security permission no file create.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionCreateRecord()

int BtrieveFileInformation::GetSecurityPermissionCreateRecord ( )

Get security permission record create.

Snippet
// If GetSecurityPermissionCreateRecord() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionCreateRecord()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionCreateRecord():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionCreateRecord = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission record create.
0Security permission no record create.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionCreateStoredProcedure()

int BtrieveFileInformation::GetSecurityPermissionCreateStoredProcedure ( )

Get security permission create stored procedure.

Snippet
// If GetSecurityPermissionCreateStoredProcedure() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionCreateStoredProcedure()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionCreateStoredProcedure():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionCreateStoredProcedure = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission create stored procedure.
0Security permission no create stored procedure.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionCreateView()

int BtrieveFileInformation::GetSecurityPermissionCreateView ( )

Get security permission create view.

Snippet
// If GetSecurityPermissionCreateView() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionCreateView()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionCreateView():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionCreateView = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission create view.
0Security permission no create view.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionDelete()

int BtrieveFileInformation::GetSecurityPermissionDelete ( )

Get security permission delete.

Snippet
// If GetSecurityPermissionDelete() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionDelete()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionDelete():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionDelete = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission delete.
0Security permission no delete.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionExecute()

int BtrieveFileInformation::GetSecurityPermissionExecute ( )

Get security permission execute.

Snippet
// If GetSecurityPermissionExecute() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionExecute()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionExecute():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionExecute = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission execute.
0Security permission no execute.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionNoRights()

int BtrieveFileInformation::GetSecurityPermissionNoRights ( )

Get security permission no rights.

Snippet
// If GetSecurityPermissionNoRights() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionNoRights()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionNoRights():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionNoRights = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission no rights.
0Security permission rights.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionOpen()

int BtrieveFileInformation::GetSecurityPermissionOpen ( )

Get security permission open.

Snippet
// If GetSecurityPermissionOpen() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionOpen()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionOpen():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionOpen = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission open.
0Security permission no open.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionRead()

int BtrieveFileInformation::GetSecurityPermissionRead ( )

Get security permission read.

Snippet
// If GetSecurityPermissionRead() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionRead()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionRead():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionRead = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission read.
0Security permission no read.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionRefer()

int BtrieveFileInformation::GetSecurityPermissionRefer ( )

Get security permission refer.

Snippet
// If GetSecurityPermissionRefer() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionRefer()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionRefer():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionRefer = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission refer.
0Security permission no refer.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSecurityPermissionUpdate()

int BtrieveFileInformation::GetSecurityPermissionUpdate ( )

Get security permission update.

Snippet
// If GetSecurityPermissionUpdate() fails.
if ((i = btrieveFileInformation.GetSecurityPermissionUpdate()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSecurityPermissionUpdate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SecurityPermissionUpdate = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0Security permission update.
0Security permission no update.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSegmentCount()

int BtrieveFileInformation::GetSegmentCount ( )

Get the segment count.

Snippet
// If GetSegmentCount() fails.
if ((segmentCount = btrieveFileInformation.GetSegmentCount()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSegmentCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SegmentCount = %d\n", segmentCount);
Return values
>= 0The exists count.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSegmented()

int BtrieveFileInformation::GetSegmented ( )

Get segmented.

Snippet
// If GetSegmented() fails.
if ((i = btrieveFileInformation.GetSegmented()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSegmented():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("Segmented = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0File is segmented.
0File isn't segmented.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSegmentFileName() [1/2]

const char* BtrieveFileInformation::GetSegmentFileName ( int  segmentFileNumber)

Get the segment file name.

Note
This method is not thread safe. The string returned will be overwritten on subsequent calls.
Parameters
[in]segmentFileNumberThe segment file number.
Snippet
// If GetSegmentFileName() fails.
if ((c = btrieveFileInformation.GetSegmentFileName(i)) == NULL)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSegmentFileName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Return values
!= NULLThe name.
NULLAn error has occurred.
Examples:
bfileinformation.cpp.

◆ GetSegmentFileName() [2/2]

Btrieve::StatusCode BtrieveFileInformation::GetSegmentFileName ( int  segmentFileNumber,
char *  name,
int  nameSize 
)

Get the segment file name.

Note
The method is available only in C++.
Parameters
[in]segmentFileNumberThe segment file number.
[out]nameThe name.
[in]nameSizeThe name size.
Return values
= Btrieve::STATUS_CODE_NO_ERRORSuccess.
!= Btrieve::STATUS_CODE_NO_ERRORAn error has occurred.
See also
Btrieve::StatusCodeToString

◆ GetSystemDataMode()

Btrieve::SystemDataMode BtrieveFileInformation::GetSystemDataMode ( )

Get the system data mode.

Snippet
// If GetSystemDataMode() fails.
if ((btrieveSystemDataMode = btrieveFileInformation.GetSystemDataMode()) == Btrieve::SYSTEM_DATA_MODE_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSystemDataMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SystemDataMode = %s\n", Btrieve::SystemDataModeToString(btrieveSystemDataMode));
Return values
!= Btrieve::SYSTEM_DATA_MODE_UNKNOWNSuccess.
= Btrieve::SYSTEM_DATA_MODE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::SystemDataModeToString
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetSystemIndexPresent()

int BtrieveFileInformation::GetSystemIndexPresent ( )

Get system index present.

Snippet
// If GetSystemIndexPresent() fails.
if ((i = btrieveFileInformation.GetSystemIndexPresent()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSystemIndexPresent():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SystemIndexPresent = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The system index is present.
0The system index isn't present.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSystemIndexSize()

int BtrieveFileInformation::GetSystemIndexSize ( )

Get the system index size.

Snippet
// If GetSystemIndexSize() fails.
if ((i = btrieveFileInformation.GetSystemIndexSize()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSystemIndexSize():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SystemIndexSize = %d\n", i);
Return values
>= 0The system index size.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSystemIndexUsed()

int BtrieveFileInformation::GetSystemIndexUsed ( )

Get system index used.

Snippet
// If GetSystemIndexUsed() fails.
if ((i = btrieveFileInformation.GetSystemIndexUsed()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSystemIndexUsed():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SystemIndexUsed = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The system index is used.
0The system index isn't used.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetSystemIndexVersion()

int BtrieveFileInformation::GetSystemIndexVersion ( )

Get the system index version.

Snippet
// If GetSystemIndexVersion() fails.
if ((i = btrieveFileInformation.GetSystemIndexVersion()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetSystemIndexVersion():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("SystemIndexVersion = %d\n", i);
Return values
>= 0The system index version.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetUnusedDuplicatePointerCount()

int BtrieveFileInformation::GetUnusedDuplicatePointerCount ( )

Get the unused duplicate pointer count.

Snippet
// If GetUnusedDuplicatePointerCount() fails.
if ((i = btrieveFileInformation.GetUnusedDuplicatePointerCount()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetUnusedDuplicatePointerCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("UnusedDuplicatePointerCount = %d\n", i);
Return values
>= 0The unused duplicate pointer count.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetUnusedPageCount()

int BtrieveFileInformation::GetUnusedPageCount ( )

Get the unused page count.

Snippet
// If GetUnusedPageCount() fails.
if ((i = btrieveFileInformation.GetUnusedPageCount()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetUnusedPageCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("UnusedPageCount = %d\n", i);
Return values
>= 0The unused page count.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetUsageCount()

int BtrieveFileInformation::GetUsageCount ( )

Get the usage count.

Snippet
// If GetUsageCount() fails.
if ((i = btrieveFileInformation.GetUsageCount()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetUsageCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("UsageCount = %d\n", i);
Return values
>= 0The usage count.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.

◆ GetVariableLengthRecordsMode()

Btrieve::VariableLengthRecordsMode BtrieveFileInformation::GetVariableLengthRecordsMode ( )

Get the variable length records mode.

Snippet
// If GetVariableLengthRecordsMode() fails.
if ((btrieveVariableLengthRecordsMode = btrieveFileInformation.GetVariableLengthRecordsMode()) == Btrieve::VARIABLE_LENGTH_RECORDS_MODE_UNKNOWN)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetVariableLengthRecordsMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("VariableLengthRecordsMode = %s\n", Btrieve::VariableLengthRecordsModeToString(btrieveVariableLengthRecordsMode));
Return values
!= Btrieve::SYSTEM_DATA_MODE_UNKNOWNSuccess.
= Btrieve::SYSTEM_DATA_MODE_UNKNOWNAn error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
See also
Btrieve::VariableLengthRecordsModeToString
Examples:
bfileattributes.cpp, and bfileinformation.cpp.

◆ GetWrongOwner()

int BtrieveFileInformation::GetWrongOwner ( )

Get wrong owner.

Snippet
// If GetWrongOwner() fails.
if ((i = btrieveFileInformation.GetWrongOwner()) < 0)
{
status = btrieveFileInformation.GetLastStatusCode();
printf("Error: BtrieveFileInformation::GetWrongOwner():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
printf("WrongOwner = %s\n", i > 0 ? "Yes" : "No");
Return values
> 0The file was opened with an incorrect owner name.
0The file wasn't opened with an incorrect owner name.
-1An error has occurred. Use BtrieveFileInformation::GetLastStatusCode to determine the Btrieve::StatusCode associated with any error.
Examples:
bfileinformation.cpp.