Products Support Documentation Download
TFS Configuration Functions
Collaboration diagram for TFS Configuration Functions:

Functions

RDM_RETCODE rdm_tfsGetOption (RDM_TFS tfs, const RDM_TCHAR_T *keyword, RDM_TCHAR_T *optValue, size_t bytesIn, size_t *bytesOut)
 Get a single TFS option into a string. More...
 
RDM_RETCODE rdm_tfsGetOptions (RDM_TFS tfs, RDM_TCHAR_T *optString, size_t bytesIn, size_t *bytesOut)
 Get TFS options. More...
 
RDM_RETCODE rdm_tfsSetOption (RDM_TFS tfs, const RDM_TCHAR_T *keyword, const RDM_TCHAR_T *strValue)
 Set a single TFS option from a string. More...
 
RDM_RETCODE rdm_tfsSetOptions (RDM_TFS tfs, const RDM_TCHAR_T *optString)
 Set TFS options. More...
 
RDM_RETCODE rdm_tfsGetCapability (RDM_TFS tfs, const RDM_TCHAR_T *name, RDM_BOOL_T *value)
 Get a TFS capability. More...
 

Detailed Description

The TFS configuration API. The functions here are located in Transactional File Server Interface Library. Linker option:

    -lrdmtfs

Function Documentation

◆ rdm_tfsGetCapability()

RDM_RETCODE rdm_tfsGetCapability ( RDM_TFS  tfs,
const RDM_TCHAR_T name,
RDM_BOOL_T value 
)

#include <rdmtfsapi.h>

Get a TFS capability.

This function retrieves a single TFS capability into a boolean value. The name parameter accepts the name for the capability to get.

Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
Parameters
[in]tfsA valid RDM_TFS
[in]namesingle option keyword
[out]valueoption value in string

◆ rdm_tfsGetOption()

RDM_RETCODE rdm_tfsGetOption ( RDM_TFS  tfs,
const RDM_TCHAR_T keyword,
RDM_TCHAR_T optValue,
size_t  bytesIn,
size_t *  bytesOut 
)

#include <rdmtfsapi.h>

Get a single TFS option into a string.

This function retrieves a single database option into a string value. The keyword argument accepts the "key" for the function to retreive into the buffer supplied by the optValue argument.

The bytesIn argument is the length of the optValue buffer.

Options are defined using keys or properties. Every key has a name and a value, delimited by an equals sign (=). The key name appears to the left of the equals sign. Key names are not case-sensitive. Unless otherwise noted, values are not case-sensitive.

Key Value Description
timeout Specify default lock timeout in seconds.
time_zone Specify current time zone.
storage Specify database storage mode.
cache_size Specify cache size.
item_format Specify row storage form.
locale Specify database locale.
error_format Specify error message format.
durability Specify database transaction safety level.
pack_file_size Specify pack file maximum size.
db_size Specify the maximum database size allocation.
vacuum_percentage Specify the vacuum trigger level for pack files.
vacuum_write_chunk_sizeSpecify the vacuum scan size for pack files.
vacuum_read_chunk_size Specify the vacuum write size for pack files.
idindex_flush_threshold_on_close Specify the threshold for flushing the ID-index when the last database user closes the database.
idindex_flush_threshold Specify the threshold for flushing the ID-index.
idindex_cache_size Specify the size of the ID-index cache in byte.

Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
eINVOPTIONVALUEInvalid option value.
See also
rdm_tfsAllocDatabase
rdm_dbOpen
rdm_dbGetOptions
rdm_dbSetOption
rdm_dbFree
Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
eRANGENumeric value out of range.
See also
rdm_tfsSetOption
rdm_rdmAllocTFS
rdm_tfsGetEncrypt
rdm_tfsGetOptions
rdm_tfsSetOptions
rdm_tfsFree
Parameters
[in]tfsA valid RDM_TFS
[in]keywordsingle option keyword
[out]optValueoption value in string
[in]bytesIn# of bytes for pszValue
[out]bytesOutA pointer to the number of bytes returned in optValue (can be NULL)

◆ rdm_tfsGetOptions()

RDM_RETCODE rdm_tfsGetOptions ( RDM_TFS  tfs,
RDM_TCHAR_T optString,
size_t  bytesIn,
size_t *  bytesOut 
)

#include <rdmtfsapi.h>

Get TFS options.

The function returns a semicolon-delimited list of keyword/value pairs for all available options into the optSting buffer.

Note
If the optString argument is NULL, the function returns the required size in bytes of the destination string in bytesOut.

Options are defined using keys or properties. Every key has a name and a value, delimited by an equals sign (=). The key name appears to the left of the equals sign. Key names are not case-sensitive. Unless otherwise noted, values are not case-sensitive.

Key Value Description
timeout Specify default lock timeout in seconds.
time_zone Specify current time zone.
storage Specify database storage mode.
cache_size Specify cache size.
item_format Specify row storage form.
locale Specify database locale.
error_format Specify error message format.
durability Specify database transaction safety level.
pack_file_size Specify pack file maximum size.
db_size Specify the maximum database size allocation.
vacuum_percentage Specify the vacuum trigger level for pack files.
vacuum_write_chunk_sizeSpecify the vacuum scan size for pack files.
vacuum_read_chunk_size Specify the vacuum write size for pack files.
idindex_flush_threshold_on_close Specify the threshold for flushing the ID-index when the last database user closes the database.
idindex_flush_threshold Specify the threshold for flushing the ID-index.
idindex_cache_size Specify the size of the ID-index cache in byte.

Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
See also
rdm_tfsAllocDatabase
rdm_dbOpen
rdm_dbGetOption
rdm_dbSetOptions
rdm_dbFree
Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
eRANGENumeric value out of range.
See also
rdm_rdmAllocTFS
rdm_tfsGetOptions
rdm_tfsSetOptions
rdm_tfsFree
Parameters
[in]tfsA valid RDM_TFS
[out]optStringoption string
[in]bytesInNumber of bytes for optString
[out]bytesOutA pointer to the number of bytes returned in optString (can be NULL)

◆ rdm_tfsSetOption()

RDM_RETCODE rdm_tfsSetOption ( RDM_TFS  tfs,
const RDM_TCHAR_T keyword,
const RDM_TCHAR_T strValue 
)

#include <rdmtfsapi.h>

Set a single TFS option from a string.

This function sets a single TFS option from a string value. The keyword parameter accepts the key for the option to set. The options are inherited by the database and/or SQL handle derived from this TFS handle.

Options are defined using keys or properties. Every key has a name and a value, delimited by an equals sign (=). The key name appears to the left of the equals sign. Key names are not case-sensitive. Unless otherwise noted, values are not case-sensitive.

Key Value Description
timeout Specify default lock timeout in seconds.
time_zone Specify current time zone.
storage Specify database storage mode.
cache_size Specify cache size.
item_format Specify row storage form.
locale Specify database locale.
error_format Specify error message format.
durability Specify database transaction safety level.
pack_file_size Specify pack file maximum size.
db_size Specify the maximum database size allocation.
vacuum_percentage Specify the vacuum trigger level for pack files.
vacuum_write_chunk_sizeSpecify the vacuum scan size for pack files.
vacuum_read_chunk_size Specify the vacuum write size for pack files.
idindex_flush_threshold_on_close Specify the threshold for flushing the ID-index when the last database user closes the database.
idindex_flush_threshold Specify the threshold for flushing the ID-index.
idindex_cache_size Specify the size of the ID-index cache in byte.

Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
eINVOPTIONVALUEInvalid option value.
See also
rdm_rdmAllocTFS
rdm_tfsGetOption
rdm_tfsSetOptions
Parameters
[in]tfsA valid RDM_TFS
[in]keywordSingle option keyword
[in]strValueoption value in string

◆ rdm_tfsSetOptions()

RDM_RETCODE rdm_tfsSetOptions ( RDM_TFS  tfs,
const RDM_TCHAR_T optString 
)

#include <rdmtfsapi.h>

Set TFS options.

This function is used to set any RDM TFS options. The optString is a key/value pair in the form of "key=value". The options are inherited by the database and/or SQL handle derived from this TFS handle.

Options are defined using keys or properties. Every key has a name and a value, delimited by an equals sign (=). The key name appears to the left of the equals sign. Key names are not case-sensitive. Unless otherwise noted, values are not case-sensitive.

Key Value Description
timeout Specify default lock timeout in seconds.
time_zone Specify current time zone.
storage Specify database storage mode.
cache_size Specify cache size.
item_format Specify row storage form.
locale Specify database locale.
error_format Specify error message format.
durability Specify database transaction safety level.
pack_file_size Specify pack file maximum size.
db_size Specify the maximum database size allocation.
vacuum_percentage Specify the vacuum trigger level for pack files.
vacuum_write_chunk_sizeSpecify the vacuum scan size for pack files.
vacuum_read_chunk_size Specify the vacuum write size for pack files.
idindex_flush_threshold_on_close Specify the threshold for flushing the ID-index when the last database user closes the database.
idindex_flush_threshold Specify the threshold for flushing the ID-index.
idindex_cache_size Specify the size of the ID-index cache in byte.

Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
eINVOPTIONVALUEInvalid option value.
See also
rdm_rdmAllocTFS
rdm_tfsSetOption
rdm_tfsGetOptions
Parameters
[in]tfsA valid TFS handle
[in]optStringThe option string