SE FreeReferenceSymbol

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

extern SE_Status_Code
SE_FreeReferenceSymbol
(
SE_Reference_Symbol	ref_symbol	(notes)
);

Definition

Frees the memory directly associated with the specified reference symbol, if any, which was allocated by this API either

during an earlier call to a function that retrieved this reference symbol, e.g. SE_GetReferenceSymbol(),
during an earlier call to a function that created this reference symbol, e.g. SE_CreateReferenceSymbol(), SE_CreateReferenceSymbolFromIntegerUnsigned()

Note that if a reference symbol has been retrieved more than once, then SE_FreeReferenceSymbol() will not actually release the memory for that reference symbol until the last reference to the reference symbol is freed; i.e., you must call SE_FreeReferenceSymbol() for a reference symbol as many times as you have retrieved that reference symbol with an API function.

Returns

SE_STAT_CODE_SUCCESS and the reference count for this reference symbol is decremented, if a valid parameter was passed in and all operations succeeded. Please note the following:

While the actual reference symbol is not destroyed until its reference count becomes zero, this handle is no longer valid once SE_FreeReferenceSymbol() has been called.

Once the final handle to a reference symbol is freed, the reference symbol is destroyed.

If a reference symbol is destroyed before being assigned to an object, then any symbolic relationships created with that reference symbol will cease to exist, since they can never be resolved at that point.

SE_STAT_CODE_INVALID_OR_NULL_REFERENCE_SYMBOL and no changes are made, if ref_symbol 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_FAILURE and no changes are made, if

ref_symbol does not have an assigned object, but has been used to create symbolic association and/or composition relationships.

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 reference symbol to be freed.

SE_STAT_CODE_SUCCESS	and the reference count for this reference symbol is decremented, if a valid parameter was passed in and all operations succeeded. Please note the following: While the actual reference symbol is not destroyed until its reference count becomes zero, this handle is no longer valid once SE_FreeReferenceSymbol() has been called. Once the final handle to a reference symbol is freed, the reference symbol is destroyed. If a reference symbol is destroyed before being assigned to an object, then any symbolic relationships created with that reference symbol will cease to exist, since they can never be resolved at that point.
SE_STAT_CODE_INVALID_OR_NULL_REFERENCE_SYMBOL	and no changes are made, if ref_symbol 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_FAILURE	and no changes are made, if ref_symbol does not have an assigned object, but has been used to create symbolic association and/or composition relationships. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.