Function Name: Transmittals Are Same

Definition

Given two SE_TRANSMITTAL handles, determines whether they reference the same SEDRIS transmittal.

Returns

SE_SUCCESS - and *result_out_ptr is set to indicate the result of the evaluation, if valid parameters were passed in and the transmittals both referenced valid, open transmittals.

SE_NULL_REQUIRED_PARAMETER - and *result_out_ptr is left unaltered, if result_out_ptr is NULL.

SE_INVALID_OR_NULL_TRANSMITTAL - and *result_out_ptr is set to SE_FALSE, if either of the transmittal parameters is not a handle to a valid, open SEDRIS transmittal.

SE_FAILURE - and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time. In this case, *result_out_ptr is set to SE_FALSE.

Prototype


extern SE_STATUS_CODE_ENUM
SE_TransmittalsAreSame
(
SE_TRANSMITTAL transmittal_a, (notes)
SE_TRANSMITTAL transmittal_b, (notes)
SE_BOOLEAN *result_out_ptr (notes)
);

Parameters Notes

transmittal_a

 the first transmittal handle that should be evaluated.

transmittal_b

 the second transmittal handle that should be evaluated.

result_out_ptr

 a pointer to an SE_BOOLEAN variable from the user.
    The *result_out_ptr value will be set by this function to SE_TRUE if
    both transmittal handles referenced the same SEDRIS transmittal.
    Otherwise, it will be set to SE_FALSE.
Prev: String To Object ID. Next: Unpublish Object. Up:Index.