Page Comparison

modelId

A numeric modelID that uniquely identifies the data model of interest in the EDMdatabase .

modelVersion

The numeric version ID that specifies the version of the model to select instances from. If unset, the version will be the latest version.

entityName

Specifies the name of the entity that defines the actual instance type to query. Entity names are case insensitive.

condition

The condition that the instances in the instance aggregate shall match. An undefined or empty string condition will match all the instances of the specified type.
A valid condition is any Express-X logical expression that refers to any number of attributes defined for the instance type specified by the argument <entityName>. The expression may also refer to attributes of referenced application instances.
Example conditions:

1. "xpxTRUETRUE"
   
   Equivalent to equivalent or empty string.
2. "(NAME LIKE "JOHN*") AND (AGE > 30)"
   
   Matches Johnny and Johnatan if they are older than 30 years.
3. "WIFE.MOTHER.DOG.NAME = "Fido""
   Matches all men with a mother in law that owns a dog named Fido.

options

Specifies the options to be used in the invocation of the xpxSelectInstancesBNEx function. The <condition> value can be specified as a bitwise OR between the actual options to enable. See the description of available options below.

attributes

Specification of the title and contents of each column of the returned query result table. The following examples illustrate the SYNTAX.

• "NAME SEX AGE" :
  The attributes name, sex and age will be returned in column 1, 2 and 3 of the returned query table. The title of the columns will be NAME, SEX and AGE respectively.
• "NAME,WIFE.MOTHER.DOG.NAME->DOG"
  The first column will contain the mans name. The second column will contain the mans mother in laws dogs name. The title of the columns will be NAME and DOG respectively.
• "DOG.NAME->DOG;xpfGetMemberCount(DOG.PUPPIES)->PUPPIES"
  
  The first column will contain the dogs name. The second column will contain its number of puppies . The title of the columns will be DOG and PUPPIES respectively.  Whitespace, comma end semicolon are all used as field delimiters.

include_exclude_filter

The numeric id of an aggregate containing the names or ids of the entities that will be affected by this filter. If the option [xpxFILTER_AS_ENTITY_IDS] is used, this parameter will be interpreted as an aggregate of instance ids, each defining an entity. If the option [xpxFILTER_AS_ENTITY_NAMES] is used, this parameter will be interpreted as an aggregate containing entity names. If the option [xpxINCLUDE_FILTER] is used, no instances but those of a type contained in the aggregate will be included. If the option [xpxEXCLUDE_FILTER] is used, all instances but those of a type contained in the aggregate will be included.

orderBy

Name of the query result column to use for sorting. The column may be specified with its constructor or by the column title.
If the <attributes> argument is:
"DOG.NAME->DOG"
The order by argument may be either "DOG" or "DOG.NAME".
This argument is only applicable when one of the options [xpxHTML_FORMAT] or [xpxASCII_FORMAT] is used. Use the options [xpxASCENDING] and [xpxDESCENDING] to specify the sorting direction.

firstIndex

All the instances of entities are kept in entity extents. All the entity extents of the entities that are to be queried (subtypes may also be queried) are joined into a single aggregate of instances. The position in this aggregate to start reading from is specified by this parameter. This way, huge populations may be incrementally queried by setting this argument equal to one more than the value of <indexOfLastFound> that resulted from the previous iterative call to this function.

maxHits

The greatest allowed number of hits in the query result. When this number of matching instances is found, the search for additional matches will stop.

xmlConfigurationName

The name of the XML configuration to apply to the resulting XML formatted query result when the option [xpxXML_FORMAT] is used.

resultFileName

The name of the file that will contain the returned XML, HTML or ASCII formatted query result. Only applicable when using the [xpxRESULT_IN_FILE] option in combination with one of the options [xpxHTML_FORMAT], [xpxASCII_FORMAT] or [xpxXML_FORMAT].

indexOfLastFound

The index of the "last returned matching element". This argument enables the caller to search for instances in an incremental way by specifying this returned "index value plus one" as the input to the next xpxSelectAggrInstancesEx function and so on.

actualHits

The number of matching instances found. If this value is equal to the <maxHits> argument, it is a possibility that there may be more matching instances among the queried entity types.

queryResultIndex

A numeric index that identifies the generated query result within internal data structures in EDM. Use the <queryResultIndex> as input to the function xpfGetQueryResultDataCell to access the actual data within the query result. is used to specify the actual EDMinstanceHashTable.

queryResultIndex = 0 : the resulting instances will be inserted in a new EDMinstanceHashTable.

               queryResultIndex != 0: Specifies an actual existing EDMinstanceHashTable, i.e., the resulting instances will be inserted (added) to the specified EDMinstanceHashTable

On return: queryResultIndex : The actual  EDMinstanceHashTable index that holds the resulting instances.

resultString

Variable that will receive the returned XML, HTML or ASCII formatted query result when the option [xpxRESULT_IN_STRING] is used with one of the options [xpxHTML_FORMAT], [xpxASCII_FORMAT] or [xpxXML_FORMAT].