xpfGetModelProperties

FUNCTION xpfGetModelProperties(modelId         : GENERIC;
                               options         : INTEGER)
                               modelProperties : SET OF STRING

The purpose of this function is to retrieve model properties that is only stored in EDM internal tables and not in an instance/object. Hence, this function is the only means for an (XPX) application to retrieve this information.

Arguments

Type	Name	Comment
GENERIC	modelId	comments
INTEGER	options

Return Value

Type

Name

Comment

SET OF STRING

modelProperties

The following properties are always returned:

MAX_INSTANCEIDS
USED_INSTANCEIDS
LOST_INSTANCEIDS
MAX_DATASIZE
USED_DATASIZE
USED_DISKSPACE
EDMFILES i.e., number of EDMfiles in model
DISKSPACE_USED_BY_EDMFILES

When the option xpxLONG_FORM is enabled the following properties are also added to the return value:

AGGREGATES i.e., number of aggregates in modelCONTINUOUS_FREE_DATASIZE
FRAGMENTED_FREE_DATASIZE
FREE_DATA_FRAGMENTS
IFILE_DISK_READS
IFILE_DISK_WRITES
DFILE_DISK_READS
DFILE_DISK_WRITES
LAST_SESSION_IFILE_DISK_READS
LAST_SESSION_IFILE_DISK_WRITES
LAST_SESSION_DFILE_DISK_READS
LAST_SESSION_DFILE_DISK_WRITES
COMMITTED_TRANSACTIONS ABORTED_TRANSACTIONS
EDMFILES_DETAILS

Property Format:

Each property (except FREE_DATA_FRAGMENTS and EDMFILES_DETAILS) are returned as a string in the following format:

PropertyName = value

Example: MAX_INSTANCEIDS = 33554429

The format of the FREE_DATA_FRAGMENTS is:

FREE_DATA_FRAGMENTS = numberOfFragments , fragmentSize , freeDataOfThisSize ; numberOfFragments , fragmentSize , freeDataOfThisSize ; ...

Each fragment has 3 values : the number of fragments, the fragment size and the total free data size in the actual fragment size. Comma is delimiter between each "fragment value" and simicolon is delimiter betwen each "fragment values".

The format of the EDMFILES_DETAILS is

EDMFILES_DETAILS = EDMfileId , EDMfileSize ; EDMfileId , EDMfileSize; .... etc

All "size values" are in bytes.

Options

Option	Comment
xpxLONG_FORM	Output long form style

Example

<Missing Example>

EDMsix

xpfGetModelProperties

Arguments

Return Value

Options

Example

See also

Filter by label