SE GetReferenceSymbol

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

extern SE_Status_Code
SE_GetReferenceSymbol
(
SE_Object			object_in,	(notes)
SE_Integer_Unsigned		*	ref_symbol_count_out_ptr,	(notes)
SE_Reference_Symbol	*	*	ref_symbol_list_out_ptr	(notes)
);

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:

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

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

Returns

SE_STAT_CODE_SUCCESS if valid parameters were passed in and all operations succeeded.

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

SE_STAT_CODE_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_STAT_CODE_UNRESOLVED_OBJECT and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if object_in is an unresolved object.

SE_STAT_CODE_OUT_OF_MEMORY and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if memory allocation failed.

SE_STAT_CODE_FAILURE and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if

object_in does not have an assigned reference symbol,

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 a handle to the object for which the reference symbol is being retrieved.

ref_symbol_count_out_ptr

 a pointer to an SE_Integer_Unsigned 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.

SE_STAT_CODE_SUCCESS	if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and no changes are made, if ref_symbol_count_out_ptr or ref_symbol_list_out_ptr is NULL.
SE_STAT_CODE_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_STAT_CODE_UNRESOLVED_OBJECT	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if object_in is an unresolved object.
SE_STAT_CODE_OUT_OF_MEMORY	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if memory allocation failed.
SE_STAT_CODE_FAILURE	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if object_in does not have an assigned reference symbol, the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.