Advantage Client Engine
Retrieves the full filename of this index order.
UNSIGNED32 |
AdsGetIndexFilename (ADSHANDLE hIndex, UNSIGNED16 usOption, UNSIGNED8 *pucName, UNSIGNED16 *pusLen); |
hIndex (I) |
Handle of index order of interest (either of an index order from an NTX or IDX file or of a tag within a CDX or ADI). |
usOption (I) |
Specifies the portion of the filename desired. Valid option are ADS_BASENAME (retrieve the name of the file without the extension), ADS_BASENAMEANDEXT (retrieve the name of the file with the extension), ADS_FULLPATHNAME (retrieve the fully qualified UNC filename). |
pucName (O) |
Return the name in this buffer. |
pusLen (I/O) |
Length of given buffer on input, length of returned data on output. |
AdsGetIndexFilename returns the file name of the index file containing the indicated index order. If ADS_FULLPATHNAME is given as the option, then the fully qualified UNC path name is returned regardless of how the file was opened. For example, even if the file was opened with a drive letter style path (e.g., f:\data\file.idx), a UNC filename will be returned by this routine (e.g., \\server\volume\data\file.idx).