SE AssignReferenceSymbolToObject

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE AssignReferenceSymbolToObject

extern SE_Status_Code
SE_AssignReferenceSymbolToObject
(
SE_Reference_Symbol	ref_symbol,	(notes)
SE_Object	object_in	(notes)
);

Definition

Assigns an object to a reference symbol previously created by the user.

Since a reference symbol allows a user to refer to an object without maintaining a handle to the object, the user may have used the reference symbol for forward referencing, via SE_AddSymbolicAssociate(), SE_AddSymbolicComponent(), or both. Consequently, when an object is assigned to the reference symbol by SE_AssignReferenceSymbolToObject(), the API identifies any symbolic association or composition relationships that have been created, then creates the real relationships between the objects.

The transmittal whose object is to be edited must be explicitly opened in UPDATE mode for this operation to succeed.

Returns

and no changes are made, if the transmittal containing object_in was opened in read-only mode.

SE_STAT_CODE_SUCCESS and ref_symbol is assigned to object_in, if valid parameters were passed in and all operations succeeded. Please note that in this case, all symbolic relationships created with ref_symbol will become actual relationships with object_in in the resulting transmittal.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and no changes are made, if object_in is not a handle to a valid, active (i.e., not freed) object.

SE_STAT_CODE_UNRESOLVED_OBJECT and no changes are made, if object_in is an unresolved object.

SE_STAT_CODE_INVALID_OR_NULL_REFERENCE_SYMBOL and no changes are made, if component_object is not a handle to a valid, active (i.e., not freed) SE_Reference_Symbol created by one of the create-reference-symbol functions.

SE_STAT_CODE_REFERENCE_SYMBOL_HAS_ASSIGNED_OBJECT and no changes are made, if the reference symbol has been assigned previously to a different object.

SE_STAT_CODE_INVALID_ACCESS_MODE

SE_STAT_CODE_FAILURE and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

ref_symbol

 the previously created reference symbol.

object_in

 the object to be assigned the reference symbol.

SE_STAT_CODE_SUCCESS	and ref_symbol is assigned to object_in, if valid parameters were passed in and all operations succeeded. Please note that in this case, all symbolic relationships created with ref_symbol will become actual relationships with object_in in the resulting transmittal.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and no changes are made, if object_in is not a handle to a valid, active (i.e., not freed) object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and no changes are made, if object_in is an unresolved object.
SE_STAT_CODE_INVALID_OR_NULL_REFERENCE_SYMBOL	and no changes are made, if component_object is not a handle to a valid, active (i.e., not freed) SE_Reference_Symbol created by one of the create-reference-symbol functions.
SE_STAT_CODE_REFERENCE_SYMBOL_HAS_ASSIGNED_OBJECT	and no changes are made, if the reference symbol has been assigned previously to a different object.
SE_STAT_CODE_INVALID_ACCESS_MODE
SE_STAT_CODE_FAILURE	and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.