To have an overview what the elements are, and how they fit into the entire database please refer to the Element Overview chapter.
In these papers only the handler functions are explained in full details.
Handler Functions
All of the element handler functions begins with the ACAPI_Element_ prefix. This function family gives support to query the element database, to modify the existing items, and also to create new instances. Refer to the functions below to have details on these topics.
The following functions manage the current setting defaults:
ACAPI_Element_GetDefaults
ACAPI_Element_GetDefaultsExt
ACAPI_Element_ChangeDefaults
ACAPI_Element_ChangeDefaultsExt
Use the functions below to enumerate elements and to query the data of an element:
ACAPI_Element_GetElemList
ACAPI_Element_GetConnectedElements
ACAPI_Element_Filter
ACAPI_Element_Get
ACAPI_Element_GetHeader
ACAPI_Element_GetMemo
ACAPI_Element_GetComponents_Obsolete
ACAPI_Element_GetDescriptors
ACAPI_Element_GetPropertyObjects
ACAPI_Element_GetQuantities
ACAPI_Element_GetMoreQuantities
ACAPI_Element_GetSurfaceQuantities
ACAPI_Element_GetRelations
ACAPI_Element_GetSyTran
ACAPI_Element_GetHotspots
ACAPI_Element_Get3DInfo
ACAPI_Element_GetLinkedPropertyObjects
ACAPI_Element_GetCategoryValue
ACAPI_Element_GetCategoryValueDefault
ACAPI_Element_ShapePrims
ACAPI_Element_ShapePrimsExt
ACAPI_Element_Decompose
ACAPI_Element_GetVisualOverriddenImage
ACAPI_Element_GetActualOverrideStyle
Modify the data of existing elements with the functions:
ACAPI_Element_Change
ACAPI_Element_ChangeExt
ACAPI_Element_ChangeMore
ACAPI_Element_ChangeMemo
ACAPI_Element_ChangeParameters
ACAPI_Element_SetLinkedPropertyObjects
ACAPI_Element_SetCategoryValue
ACAPI_Element_SetCategoryValueDefault
ACAPI_Element_Edit
ACAPI_Element_Tool
Other control functions:
ACAPI_Element_Create
ACAPI_Element_CreateExt
ACAPI_Element_Delete
ACAPI_Element_Select
ACAPI_Element_GrantElements
Controlling the user data assigned to an element:
ACAPI_Element_GetUserData
ACAPI_Element_SetUserData
ACAPI_Element_DeleteUserData
Monitoring elements:
ACAPI_Element_AttachObserver
ACAPI_Element_DetachObserver
ACAPI_Element_GetObservedElements
Creating links between elements:
ACAPI_Element_Link
ACAPI_Element_Unlink
ACAPI_Element_GetLinks
ACAPI_Element_GetLinkFlags
Solid operations between elements:
ACAPI_Element_SolidLink_Create
ACAPI_Element_SolidLink_GetFlags
ACAPI_Element_SolidLink_GetOperation
ACAPI_Element_SolidLink_GetOperators
ACAPI_Element_SolidLink_GetTargets
ACAPI_Element_SolidLink_GetTime
ACAPI_Element_SolidLink_Remove
ACAPI_Element_SolidOperation_Create
Composition of Roof and Shell elements:
ACAPI_Element_Trim_Elements
ACAPI_Element_Trim_ElementsWith
ACAPI_Element_Trim_Remove
ACAPI_Element_Trim_GetTrimType
ACAPI_Element_Trim_GetTrimmedElements
ACAPI_Element_Trim_GetTrimmingElements
ACAPI_Element_Merge_Elements
ACAPI_Element_Merge_GetMergedElements
ACAPI_Element_Merge_Remove
IFC data management:
ACAPI_Element_GetElemListByIFCIdentifier
ACAPI_Element_GetIFCIdentifier
ACAPI_Element_GetIFCType
ACAPI_Element_GetIFCAttributes
ACAPI_Element_SetIFCAttribute
ACAPI_Element_GetIFCProperties
ACAPI_Element_SetIFCProperty
ACAPI_Element_RemoveIFCProperty
ACAPI_Element_GetIFCClassificationReferences
ACAPI_Element_SetIFCClassificationReference
ACAPI_Element_RemoveIFCClassificationReference
ACAPI_Element_GetIFCPropertyValuePrimitiveType
Properties:
ACAPI_Element_GetPropertyDefinitions
ACAPI_Element_GetPropertyValuesOfDefaultElem
ACAPI_Element_GetPropertyValues
ACAPI_Element_GetPropertyValuesByGuid
ACAPI_Element_GetPropertiesDefault
ACAPI_Element_SetProperties
ACAPI_Element_SetPropertiesOfDefaultElem
ACAPI_Element_SetProperty
ACAPI_Element_IsPropertyDefinitionAvailable
ACAPI_Element_IsPropertyDefinitionAvailableDefault
ACAPI_Element_IsPropertyDefinitionValueEditable
ACAPI_Element_IsPropertyDefinitionValueEditableDefault
ACAPI_Element_IsPropertyDefinitionVisible
ACAPI_Element_IsPropertyDefinitionVisibleDefault
ACAPI_ElementList_AddProperty
ACAPI_ElementList_ModifyPropertyValue
ACAPI_ElementList_DeleteProperty
Classifications of the elements:
ACAPI_Element_GetClassificationItems
ACAPI_Element_GetClassificationInSystem
ACAPI_Element_AddClassificationItem
ACAPI_Element_RemoveClassificationItem
ACAPI_Element_GetClassificationItemsDefault
ACAPI_Element_GetClassificationInSystemDefault
ACAPI_Element_AddClassificationItemDefault
ACAPI_Element_RemoveClassificationItemDefault
ACAPI_Element_IsClassificationItemVisible
ACAPI_Element_IsClassificationItemVisibleDefault
Converter functions:
ACAPI_Element_UnIdToGuid
ACAPI_Element_GuidToUnId
ACAPI_Element_LinkIdToDrwGuid
ACAPI_Element_DrwGuidToLinkId
Collision detection function:
ACAPI_Element_GetCollisions
General Error Codes
|
The current database is not proper for the operation. |
|
invalid reference; |
|
invalid reference; |
|
permission denied; |
Notes
All the functions are working on the current database; refer to the ACAPI_Database function how to control the current database.