SE GetSortKey

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

extern SE_Status_Code
SE_GetSortKey
(
SE_Object		object_in,	(notes)
SE_Integer_Unsigned	*	sort_key_out_ptr	(notes)
);

Definition

Returns a value that can be used as a sort key for the given instance.

Note that the value is only valid while the given handle to the instance remains in memory.

Returns

SE_STAT_CODE_SUCCESS and *sort_key_out_ptr is set appropriately, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *sort_key_out_ptr is left unaltered, if sort_key_out_ptr was NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *sort_key_out_ptr is set to zero (0), if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.

SE_STAT_CODE_UNRESOLVED_OBJECT and *sort_key_out_ptr is set to zero (0), if object_in is unresolved.

SE_STAT_CODE_FAILURE and *sort_key_out_ptr is set to zero (0), if 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

 the SEDRIS object whose sort key is being requested.

sort_key_out_ptr

 a pointer to a variable in the user's memory space
    where the answer will be stored.

SE_STAT_CODE_SUCCESS	and *sort_key_out_ptr is set appropriately, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *sort_key_out_ptr is left unaltered, if sort_key_out_ptr was NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *sort_key_out_ptr is set to zero (0), if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and *sort_key_out_ptr is set to zero (0), if object_in is unresolved.
SE_STAT_CODE_FAILURE	and *sort_key_out_ptr is set to zero (0), if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.