Page Comparison

ALL_ATTRIBUTES

When the argument <attributes> is NULL or an empty string, all attributes of the instances will be included in the query result. However, if the <attributes> argument is used to add one or more aditional constructed columns or to rename a column in the query result, the return of all the instance attributes will be hindered due to an <attributes> argument that is no longer NULL or an empty string. Use this option to force the including of all instance attributes even when the <attributes> argument is not NULL or an empty string. This option is only applicable on aggregates of instances.

INCLUDE_CONFIGURATION

Include configuration element when writing ISO_10303_28 document

INCLUDE_SCHEMA

Include schema elements when writing ISO_10303_28 document

RESULT_IN_STRING

The resulting table will be returned in a string allocated in heap-memory of the calling application. Use edmiFree to release allocated memory. Use the option [RESULT_IN_XML_FILE] to write the table to a file.

OPEN_MODEL_FOR_WRITE_ACCESS

Use this option if the query function contains statements that will or might create or update the population within the source model.

EXTRACT_SHALLOW

Use this option to force a shallow XML formatted query result. ISO10303-28 compliant XML Query results are deep by default. No other query result format supported by this function is deep. Hence, this option has no effect unless combined with the option [XML_FORMAT].

ASCENDING

Arrange the query result in ascending order. This option is only applicable when the <orderBy> argument is used.

DESCENDING

Arrange the query result in descending order. This option is only applicable when the <orderBy> argument is used.

RESULT_AS_ID

When the declared return value of a query function is of type sdaiAGGR, the output will be returned as a scratch aggregate Id in the attribute data.value.aggrVal of the returned SdaiQueryResult struct.
[RESULT_AS_ID] is the default option value.

RESULT_AS_ID_CONTENTS

When the declared return value of a query function is of type sdaiAGGR, the output will be returned as a table with one column and n rows, where n is the number of elements in the returned aggregate.

RESULT_IN_XML_FILE

The output from the query function will be converted to XML code and written to the file specified in the parameter <resultFileFileName>

EDM_IDENTIFIERS

Use the full internal instanceIds of EDM as step Ids in the exported XML file. By default, the step Ids are the local references from within each model.

RESULT_AS_TABLE

Specifies that the result of the edmiExecuteQueryExBN operation should be returned as a table. This option is only valid when the EDMquery result is an aggregate of instances or an aggregate of view instances.  The number of elements in the aggregate will be the number of rows in the table and the number of attributes in the actual instance type or view type will be the number of columns in the table.

HTML_FORMAT

The query result table will be presented in HTML format in a locally allocated string or in a file on the local file system. See the options [RESULT_IN_XML_FILE] and [RESULT_IN_STRING].

ASCII_FORMAT

The query result table will be presented in plain ASCII format in a locally allocated string or in a file on the local file system. See the options [RESULT_IN_XML_FILE] and [RESULT_IN_STRING].

OLD_XML_FORMAT

The result of the query will be returned in a simple wellformed well formed XML formatted file on the local file system.

XML_FORMAT

The result of the query will be returned in an ISO10303-28 compliant XML formatted string or in a file on the local file system.

ZIPPED_FILE

The file given by the argument <resultFileName> will be compressed with gzip . This option has no effect unless combined with the option [RESULT_IN_XML_FILE].

IGNORE_EMPTY_COLUMNS

Columns for attributes that do not have defined values for any of the returned instances will be left out of the query result table.