Expand/Collapse all

GetProperties method

Overview

Returns the identifier, the type and the properties of the object.

Because it is not mandatory to set all properties when you define an object, the GetProperties method may show properties that were not set. In that case, default values are given.

If the object contains some soft properties, the soft properties are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

If the object is linked to another object, the properties of the linking object are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

Parameters

None

Output

The following is always returned in the output:

GenericObjectProperties

Name	Description	Type
qInfo	Identifier and type of the object. This parameter is mandatory.	NxInfo
qExtendsId	Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). This parameter is mandatory. If you do not want to link your object, set this parameter to an empty string.	String
qMetaDef	Definition of the dynamic properties.	Dynamic properties

NxInfo

Name	Description	Type
qId	Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. This parameter is optional. If an identifier is not set, the engine automatically sets one.	String
qType	Type of the object. This parameter is mandatory.	String