VA FileMan Programmer Manual: $$ROOT^DILFD( )

Contents:

Main

Database Server (DBS) API

$$ROOT^DILFD( ): File Root Resolver

This extrinsic function resolves the file root when passed file or subfile numbers. At the top level of the file $$ROOT returns the global name. When passing a subfile number, $$ROOT uses the IENS to build the root string.

Format

$$ROOT^DILFD(FILE,IENS,FLAGS,ERROR_FLAG)

Input Parameters

FILE	(Required) File number or subfile number.
IENS	(Required when passing subfile numbers) Standard IENS indicating internal entry number.
FLAGS	(Optional) If set to 1 (true), returns a closed root. The default is to return an open root.
ERROR_FLAG	(Optional) If set to 1 (true), processes an error message if error is encountered.

Examples

Example 1

    >S DIC=$$ROOT^DILFD(999000.07,"1,38,")
    
    >W DIC
    ^DIZ(999000,38,2,

Example 2

    >S DIC=$$ROOT^DILFD(999000)
    
    >W DIC
    ^DIZ(999000,

Example 3

    >S CROOT=$$ROOT^DILFD(999000,"",1)
    
    >W CROOT
    ^DIZ(999000)

Error Codes Returned

200	Invalid parameter
205	The File and IENS represent different subfile levels.

Reviewed/Updated: March 10, 2007