Apollo VCL Components > Apollo VCL Component Reference > TApolloEnv

$image\TAPOLLOENV.gif$

The TApolloEnv component controls the global environment of all TApolloTable objects in the application. These include Century, Deleted, Epoch, SoftSeek, and more.

The TApolloDatabase component is only required if your application must modify or query the settings that it controls.

If used, only one TApolloEnv component generally needs to be used for the entire application. The only exception to this rule would be if you are using Apollo Database Server and you have both local and remote tables and you want the local and remote tables to use different environmental settings. In this one case, you could use two TApolloEnv components where one has the ApplyTo property set True on apLocal only, and the other where the ApplyTo property is set to True on ApServer only.

Also, when dealing with remote tables via Apollo Database Server, always make sure that you have connected the TApolloEnv to the TApolloConnection by setting the TApolloEnv.ApolloConnection property. Otherwise, the calls will not be sent anywhere.

There is another important note to remember, when using TApolloEnv with TApolloQuery. Say, for example, that you issue a SQL SELECT statement with a TApolloEnv.Deleted = False, and then switch Deleted to True after getting the result set back. The result set (which is now on the client side) will not reflect the change sent by TApolloEnv to the server until the next time you reissue the SELECT statement.

Properties	Description
ApolloConnection	Identifies the TApolloConnection component to attach this TApolloEnv to. The TApolloConnection is then connected to the Apollo Server.
ApplyTo	Determines if environmental settings should be applied to local and/or remote tables.
AutoRefresh	Controls automatically refreshing all datasets when certain environmental settings are changed.
Century	Sets/Gets whether or not the two digits of the year designating century are to be returned by TApolloTable's GetDateString method as part of a date string formatted according to the DateFormat setting.
DateFormat	Sets/Gets the format of date strings returned by GetDateString.
Deleted	Gets/Sets state of deleted records, either transparent or visible, to record positioning functions.
Epoch	Gets/Sets the interpretation of date strings with only two year digits.
Exact	Gets/Sets whether or not Seeks are to return True if a partial key match is made.
LockTimeout	Gets/Sets the number of seconds allowed to retry a lock operation before failing.
MemoBlockSize	Gets/Sets a new default block size that will be used when creating any new table that has memos and will also change the block size in memo files when the DBF is packed.
OptimisticBuffer	Gets/Sets the Optimistic Buffering setting. For applications not running on a Novell Netware server, this should usually be set to False (off).
SoftSeek	Gets/Sets whether or not index seeks that result in failure (i.e., the requested key value does not match any key in the index order either partially or exactly) should result in a successful conclusion if a key is found that is immediately greater than the requested key.

Methods	Description
CloseDataSets	Closes all TApolloTable components within the application.
ErrorLevel	Sets the level of automatic error messaging used by Apollo.
OpenDataSets	Opens all TApolloTable components within the application.
RefreshDataSets	Issues a Refresh call to all TApolloTable components within the application.
SetCentury	Indicates whether or not the two digits of the year designating century are to be returned by TApolloTable's GetDateString method as part of a date string formatted according to the SetDateFormat setting.
SetDateFormat	Defines the format of date strings returned by GetDateString.
SetDeleted	Makes deleted records either transparent or visible to record positioning functions.
SetEpoch	Determines the interpretation of date strings with only two year digits.
SetErrorFunc	Allows defining a function to be called in place of Apollo's error message when an Apollo error is raised.
SetExact	Indicates whether or not Seeks are to return True if a partial key match is made.
SetLockTimeout	Sets the number of seconds allowed to retry a lock operation before failing.
SetMemoBlockSize	Sets a new default block size that will be used when creating any new table that has memos and will also change the block size in memo files when the DBF is packed.
SetSoftSeek	Indicates whether or not index seeks that result in failure (i.e., the requested key value does not match any key in the index order either partially or exactly) should result in a successful conclusion if a key is found that is immediately greater than the requested key.