SE ObjectsAreSame

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

extern SE_Status_Code
SE_ObjectsAreSame
(
SE_Object		object1_in,	(notes)
SE_Object		object2_in,	(notes)
SE_Boolean	*	result_out_ptr	(notes)
);

Definition

Checks whether two SE_Objects both refer to the same SEDRIS object.

Returns

SE_STAT_CODE_SUCCESS and *result_out_ptr is set to the result of the check, if valid parameters were passed in and all operations succeeded.

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

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *result_out_ptr is set to SE_FALSE, if either object1_in or object2_in is not a handle referencing a valid SEDRIS object from an open transmittal.

SE_STAT_CODE_UNRESOLVED_OBJECT and *result_out_ptr is set to SE_FALSE, if either object1_in or object2_in is not a currently resolved object (see SE_Object's comments for details on how this condition occurs).

SE_STAT_CODE_FAILURE and *result_out_ptr is set to SE_FALSE, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object1_in

 the first object to be compared; must be resolved.

object2_in

 the second object to be compared; must be resolved.

result_out_ptr

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

SE_STAT_CODE_SUCCESS	and *result_out_ptr is set to the result of the check, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *result_out_ptr is left unaltered, if result_out_ptr was NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *result_out_ptr is set to SE_FALSE, if either object1_in or object2_in is not a handle referencing a valid SEDRIS object from an open transmittal.
SE_STAT_CODE_UNRESOLVED_OBJECT	and *result_out_ptr is set to SE_FALSE, if either object1_in or object2_in is not a currently resolved object (see SE_Object's comments for details on how this condition occurs).
SE_STAT_CODE_FAILURE	and *result_out_ptr is set to SE_FALSE, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.