QueryByContainer client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The QueryByContainer client API is used to query the database for objects based on their container.

Argument

Description

Parameter 1

Relationship column set

Parameter 1 default

None

Parameter 1 description

The column set to be used to display returned relationships.

Parameter 1 type

String

Parameter 2

Object column set

Parameter 2 default

None

Parameter 2 description

The column set to be used to display returned objects.

Parameter 2 type

String

Parameter 3

ExportToDirectory

Parameter 3 default

False

Parameter 3 description

True indicates that the results should be exported to a selected directory instead of being displayed in a list view. False indicates that the results will be displayed in the list view.

Parameter 3 type

Boolean

The following methods use the QueryByContainer client API to pull information from the database by the container it is stored in.

  • SPFExportByContainer

  • SPFQueryByContainer