SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE TransmittalsAreSame
extern SE_Return_Code
SE_TransmittalsAreSame
(
SE_Transmittal transmittal_a,1
SE_Transmittal transmittal_b,2
SE_Boolean *result3
);

Definition

Given the two transmittal handles specified by transmittal_a and transmittal_b, this function determines if the two handles reference the same transmittal. If they reference the same transmittal, result returns the value SE_TRUE. Otherwise, result returns the value SE_FALSE.


Returns

SE_RETCOD_SUCCESS the transmittal handles refer to the same transmittal.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if valid parameters were passed in and the transmittals referenced are both valid and open.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

1 the first transmittal handle that should be evaluated.

2 the second transmittal handle that should be evaluated.

3 a pointer to an SE_Boolean variable from the user. The *result value will be set by this function to SE_TRUE if both transmittal handles referenced the same transmittal. Otherwise, it will be set to SE_FALSE.


Prev: SE_SetUserData. Next: SE_UnpublishObject. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS