Difference between revisions of "CDX()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Class==
 
Indexing
 
 
 
 
==Purpose==
 
==Purpose==
 
Function to return the active multiple index filename
 
Function to return the active multiple index filename
Line 12: Line 8:
  
 
==See Also==
 
==See Also==
[[DB_MAXWKA]], [[FOR()]], [[KEY()]], [[NDX()]], [[ORDER()]], [[SET()]], [[SET COMPATIBLE]], [[SET FILECASE]], [[SET FULLPATH]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]]
+
[[FOR()]], [[KEY()]], [[MDX()]], [[NDX()]], [[ORDER()]], [[SET()]], [[SET COMPATIBLE]], [[SET FILECASE]], [[SET FULLPATH]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]]
  
  
 
==Description==
 
==Description==
 
The CDX() function returns the name of the currently open multiple index file.  Used without any parameters, the CDX() function will return the name of the multiple index file in the current workarea.  If there is no .dbx file in the workarea, the CDX() function will return a null string.  The optional numeric expression, <expN>, may be used to return the .dbx file name for a specific tag number.  This parameter is needed if more than one .dbx file is open in a workarea.  You may optionally specify an alias name to use the CDX() function in other workareas.  The <alias> may be a workarea number or letter  
 
The CDX() function returns the name of the currently open multiple index file.  Used without any parameters, the CDX() function will return the name of the multiple index file in the current workarea.  If there is no .dbx file in the workarea, the CDX() function will return a null string.  The optional numeric expression, <expN>, may be used to return the .dbx file name for a specific tag number.  This parameter is needed if more than one .dbx file is open in a workarea.  You may optionally specify an alias name to use the CDX() function in other workareas.  The <alias> may be a workarea number or letter  
(1-DB_MAXWKA, a-z) or the table alias name.
+
or the table alias name.
  
 
If SET COMPATIBLE is set to FOXPRO or VFP the CDX() return value format differs in the following way: if SET FULLPATH is ON the full path to the index file is returned, if SET FILECASE is OFF then the return value is converted to upper case (Windows only).
 
If SET COMPATIBLE is set to FOXPRO or VFP the CDX() return value format differs in the following way: if SET FULLPATH is ON the full path to the index file is returned, if SET FILECASE is OFF then the return value is converted to upper case (Windows only).
Line 30: Line 26:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital Server, Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Indexing]]
 +
[[Category:Indexing Functions]]

Latest revision as of 16:32, 15 December 2009

Purpose

Function to return the active multiple index filename


Syntax

CDX([<expN>[,<alias>]])


See Also

FOR(), KEY(), MDX(), NDX(), ORDER(), SET(), SET COMPATIBLE, SET FILECASE, SET FULLPATH, TAG(), TAGCOUNT(), TAGNO()


Description

The CDX() function returns the name of the currently open multiple index file. Used without any parameters, the CDX() function will return the name of the multiple index file in the current workarea. If there is no .dbx file in the workarea, the CDX() function will return a null string. The optional numeric expression, <expN>, may be used to return the .dbx file name for a specific tag number. This parameter is needed if more than one .dbx file is open in a workarea. You may optionally specify an alias name to use the CDX() function in other workareas. The <alias> may be a workarea number or letter or the table alias name.

If SET COMPATIBLE is set to FOXPRO or VFP the CDX() return value format differs in the following way: if SET FULLPATH is ON the full path to the index file is returned, if SET FILECASE is OFF then the return value is converted to upper case (Windows only).


Example

?cdx(1, account)
invoice.dbx


Products

Recital Server, Recital