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

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...

Detailed Description

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

    -lrdmtfs

Function Documentation

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 runtime TFS option into a string value. The keyword parameter accepts the key for the option to get. 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_size	Specify 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

sOKAY	Normal, successful return.
eINVOPTION	Invalid option is specified.
eRANGE	Numeric value out of range.

See also: rdm_tfsSetOption; rdm_rdmAllocTFS; rdm_tfsGetEncrypt; rdm_tfsGetOptions; rdm_tfsSetOptions; rdm_tfsFree

Parameters

[in]	tfs	[in] A valid RDM_TFS
[in]	keyword	[in] single option keyword
[out]	optValue	[out] option value in string
[in]	bytesIn	[in] # of bytes for pszValue
[out]	bytesOut	[out] A 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 options in the pair of keyword and value for the options specified in keywords.

Keywords should be a list of option values. If keyword is NULL, the function returns the pairs for all available options. If keyword is an empty string, the function returns an empty string.

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_size	Specify 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

sOKAY	Normal, successful return.
eINVOPTION	Invalid option is specified.
eRANGE	Numeric value out of range.

See also: rdm_rdmAllocTFS; rdm_tfsGetOptions; rdm_tfsSetOptions; rdm_tfsFree

Parameters

[in]	tfs	[in] A valid RDM_TFS
[out]	optString	[out] option string
[in]	bytesIn	[in] Number of bytes for optString
[out]	bytesOut	[out] A 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_size	Specify 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

sOKAY	Normal, successful return.
eINVOPTION	Invalid option is specified.
eINVOPTIONVALUE	Invalid option value.

See also: rdm_rdmAllocTFS; rdm_tfsGetOption; rdm_tfsSetOptions

Parameters

[in]	tfs	[in] A valid RDM_TFS
[in]	keyword	[in] Single option keyword
[in]	strValue	[in] option 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_size	Specify 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

sOKAY	Normal, successful return.
eINVOPTION	Invalid option is specified.
eINVOPTIONVALUE	Invalid option value.

See also: rdm_rdmAllocTFS; rdm_tfsSetOption; rdm_tfsGetOptions

Parameters

[in]	tfs	[in] A valid TFS handle
[in]	optString	[in] The option string