Page Comparison

serverContextId

Context identification, from edmiDefineServerContext

currInst

The instance Id that uniquely identifies the application instance in the remote EDMdatabasefor which the given condition shall be checked for all its external references.

version

The version number of the edmModel to run the query on. The version number is a sequense number counting from one by increments of one. Use version 0 for current version.

condition

The condition that the instances in the reference aggregate shall match. A NULL or empty string condition will match all the instances in the aggregate.  A valid condition is any Express-X logical expression that refers to any number of attributes defined for the reference instance type. Because the reference aggregate may contain instances of any type, the situation where the condition referees to attributes that are not defined for that particular instance type may occur. In this case, the logical expression will evaluate to xpxUNKNOWN. Hence, that instance will not be considered matching the condition.
Example conditions:
"xpxTRUETRUE"
Equivalent to NULL or empty string. Matches all the elements in the reference aggregate.
"(NAME LIKE 'John*') AND (AGE > 30)"
Maches Matches Johnny and Johnatan Jonathan if they are older than 30 years.
"WIFE.MOTHER.DOG.NAME = 'Fido'"
Matches all men with a mother in law that owns a dog named Fido.

options

See description of available options below.  Options may be joined by using bitwise OR operator

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.  If an attribute is not relevant for an instance, its returned value will be unset. Whitespace, comma end semicolon are all used as field delimiters.

include_exclude_filter

A zero-terminated buffer of entityIds or a NULL-terminated buffer of string pointers to entity names.

• If the option FILTER_AS_ENTITY_IDS is used, this parameter will be interpreted as a buffer of entityIds
• If the option FILTER_AS_ENTITY_NAMES is used, this parameter will be interpreted as a buffer of strings containing entity names.
• If the option INCLUDE_FILTER is used, only instances of the entities explicitly listed in this argument will be searched.
• If the option EXCLUDE_FILTER is used, instances of any type except for the entities listed in this argument will be searched.

orderBy

Name of the query result column to use for sorting. The column may be specified by 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 HTML_FORMAT or ASCII_FORMAT is used. Use the options ASCENDING and DESCENDING to specify the sorting direction.

index

• In: The index of the element in the reference aggregate to start searching from. The first element in the reference aggregate is indexed zero. Hence the legal index range is: [ 0 <= index < N ] , where N is the number of instances in the reference aggregate.
• Out: The index of the "last returned matching element" +1. Hence it may be used as input value for a succeeding call to the same function. This way, the second call will start reading instances where the first call finished.

numberOfHits

• In: Specifies the maximum number of matching instances to return.
• Out: The number of matching instances found.

queryResult

A variable that will receive the result of the query. Use edmiFreeQueryResult to release allocated memory.

xmlConfigurationName

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

resultString

Variable that will receive the returned XML, HTML or ASCII formatted query result when the option RESULT_IN_STRING is used with one of the options HTML_FORMAT, ASCII_FORMAT or XML_FORMAT.

resultFileName

The name of the file that will contain the returned XML, HTML or ASCII formatted query result. Only applicable when using the RESULT_IN_FILE option in combination with one of the options HTML_FORMAT, ASCII_FORMAT or XML_FORMAT.
Use the ZIPPED_FILE option to compress the generated file.

edmiInvocationId

Currently not used.