Whether this Document is defined to be per user.
Valid Values
“yes” or “no” (the default value is “no”).
Remarks
Normally, Documents are located in a place pointed by its FileName field. However, with DocPerUser set to “yes”, the corresponding document has the following behaviour:
. They are handled by the current session and their information is lost after the session finishes;
. They are located in the $WorkPath directory;
. They don’t exist at the beginning of the session and must explicitly be generated on the fly by the application.
Note: In previous versions of Zim, per user Documents were indicated by the “)” mark in the FileNome of the document. In Zim 8 and up, the DocPerUser field must be set to “yes” and the “)” mask must be there as well for compatibity issues. In future versions, this mark will be removed.
The name of an application directory (Directories); otherwise, the one application directory in which the associated object may exist.
Valid Values
An 18-character string, containing a valid object name
Remarks
In Directories:
DirName is the name assigned to the directory.
In other Object Dictionary entity sets:
In any entity set, the principal object’s DirName must match the DirName of its owner.
If DirName is left blank, the object may exist in any number of application directories.
In DDDescriptions, DirName is where the object being described may be found.
In DisplayForms, DirName is where the owner-display of the associated form may be found.
See Also
ConstName, DDObjectName, DDOwnerName, DisplayName, DocName, EntName, FieldName, FormName, MenuName, OwnerName, RelName, RoleName, SetName, UserName, VarName
The operating system name of a file or an input/output device. The file or device that the document represents.
Valid Values
Up to 256 alphanumeric and special characters (see “Remarks”, below, for details)
Remarks
Files
FileName can refer to a file that already exists, or it may contain the name of a file that the application will create.
A number of special prefix characters are available to denote particular operating system directory locations for files, as described below:
Prefix | Meaning |
) | The file is located in the work directory (a “per user” file) |
# | The file is located in the directory named in the ZIM= entry in the [ZIM] section of the ZIM.INI file (found in the Windows directory). This directory is normally the directory in which you installed Zim |
“ | The file is located in the database directory. The database directory is the default location for most Zim files; this special prefix is typically used with foreign directories |
^ | The file is located in the directory named in the IMAGEPATH= entry in the [ZIM] section of the ZIM.INI file (found in the WIndows directory). The image directory can be specified in the Screen Painter as the location for any supported image file type (e.g., bitmaps, icons, metafiles) |
~ | The file is located in the directory named in the CLIPPATH= entry in the [ZIM] section of the ZIM.INI file (found in the WIndows directory). The clip directory is used by the Screen Painter to store files involved in Cut, Copy, and Paste operations |
See Distributing Database Files for more information on how to distribute files in a Zim database.
Devices
FileName can refer to an input/output device connected to your computer.
A number of special keywords are available to refer to standard devices known to the operating system. These keywords can be used in place of specific device names in the FileName field. The keywords and the device each represents are described below:
File Name | Meaning |
$console | The terminal from which the application is being run |
$stdin$ | Standard input device as defined by the operating system |
$stdout$ | Standard output device as defined by the operating system |
$stderr$ | Output is directed to the ZimTrace window if the ZIMTRACE utility program is running. The window accumulates, displays, or logs the output to a file. If ZIMTRACE is not running, the output is discarded |
$clipboard | Standard clipboard as defined by MS-Windows |
See Also
Foreign
A user-assigned classification for a document.
Valid Values
Up to 18 alphanumeric characters
The name assigned to a document.
Valid Values
An 18-character string, containing a valid object name
See Also
ConstName, DDObjectName, DDOwnerName, DirName, DisplayName, EntName, FieldName, FormName, MenuName, OwnerName, RelName, RoleName, SetName, UserName, VarName
The number of records in the database object. An estimate of the number of records in an entity set, named set, relationship with fields or an estimate of the number of records (lines) in a document.
Valid Values
A non-negative number (vastint)
If you enter 0 or leave the field blank, an internal default value is used.
Remarks
AvgSize is used by the strategy analyzer to determine the most efficient access strategy when a database object is used in a set specification. AvgSize does not restrict the physical size of the object in any way.
A unique identifier assigned by the Development Center.
Valid Values
A 25-character string (DEFAULT = $Null)
Remarks
ObjectKey is a unique identifier assigned by the Zim Development Center if the Object Manager (ZOM) has been enabled. End-users should not modify its value. Refer to the Development Center documentation for more information.
ObjectKey has a defined ListWidth of -1 and is not normally displayed.
English 
Portuguese