Bt_DictGet() Function

 

<< Click to Display Table of Contents >>

Navigation:  Ddf Dictionary >

 

Bt_DictGet() Function

 

Previous pageReturn to chapter overviewNext page

 

Purpose

 

 

Get Dictionary files from Dictionary Cache

 

 

 

Prototype

 

 

FUNCTION Bt_DictGet ( cPath  := NULL_STRING AS STRING, symClass AS SYMBOL )  AS OBJECT

 

 

 

Argument(s)

 

 

<cPath> (Optional) location for DDF Files. Default = Bt_Path() location
<symClass>SYMBOL indicating type of object to read from Dictionary.
Can be one of the following:
#Dict            Will return the BtDict object containing all the references to
               the Dictionary Server objects
#File            Will return the BtServer object for File.DDF
#Field            Will return the BtServer object for Field.DDF
#Index            Will return the BtServer object for Index.DDF
 
The following files will only be returned when the Dictionary is opened in Extended mode and when they are available
#Comment          Will return the BtServer object for Comment.DDF
#FieldExt          Will return the BtServer object for FieldExt.DDF

 

 

 

 

Return

 

 

OBJECTObject that was asked for with symClass parameter

 

 

 

Description

 

 

With this function you can get a reference dictionary servers from a Dictionary that is previously opened using BT_DictOpen()

Please note: The same dictionary may be in use from more than one location. You should NEVER call Close() on the servers that you have retrieved using this function.

 

 

 

See Also

 

 

Bt_DictOpen(), Bt_DictClose(), BtDict