Function Name: Get Reference Symbol

Definition

Retrieves a list containing all reference symbols corresponding to the given object, if any reference symbols have been assigned to the object through SE_AssignReferenceSymbolToObject().

NOTES:

1. The user is responsible for freeing the memory allocated to * ref_symbol_list_out_ptr.

2. The user is responsible for freeing the individual reference symbols in * ref_symbol_list_out_ptr, using SE_FreeReferenceSymbol().

Returns

SE_NULL_REQUIRED_PARAMETER - and no changes are made, if ref_symbol_count_out_ptr or ref_symbol_list_out_ptr is NULL.

SE_INVALID_OR_NULL_OBJECT - and *ref_symbol_count_out_ptr is set to zero (0) and *ref_symbol_list_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.

SE_UNRESOLVED_OBJECT - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if object_in is an unresolved object.

SE_OUT_OF_MEMORY - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if memory allocation failed.

SE_FAILURE - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if

1. object_in does not have an assigned reference symbol,
2. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype

Parameters Notes

object_in

 the object for which the reference symbol is being retrieved.

ref_symbol_count_out_ptr

 a pointer to an SE_UINT32 variable in the
    user's memory space where the number of reference symbols corresponding
    to object_in (i.e., the size of the *ref_symbol_list_out_ptr array) will
    be placed.

ref_symbol_list_out_ptr

 a pointer to the array of reference symbols returned
    for the given object.