SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetTransmittalName
extern SE_Return_Code
SE_GetTransmittalName
(
SE_Transmittal  transmittal,1
SE_Store  store,2
SE_URN  *name3
);

Definition

Given a handle to a transmittal specified in transmittal, this function returns in name the formal transmittal name associated with the transmittal in the form of a URN.


Returns

SE_RETCOD_SUCCESS and the transmittal name is returned.
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 call was successful.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_OUT_OF_MEMORY and no changes are made if sufficient memory could not be allocated.
SE_STATCODE_C_STORE_INVALID and no changes are made if store is not a handle to a valid SE_Store.
SE_STATCODE_INACTIONABLE_FAILURE and no changes are made if
  1. transmittal is not a valid handle to an open transmittal; or
  2. the call fails for any other reason

Parameters Notes

1 the transmittal for which the name is being requested.

2 the store to be used when allocating the string used to return the transmittal name.

3 a pointer to an SE_URN variable from the user. The transmittal name will be returned via this parameter. The storage for the character string returned will be allocated within the store passed in.

Prev: SE_GetTransmittalLocation. Next: SE_GetTransmittalVersionInformation. Up:Index.

Last updated: July 1, 2011 Copyright © 2011 SEDRIS™