SE SetTransmittalName

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE SetTransmittalName

extern SE_Return_Code
SE_SetTransmittalName
(
	SE_Transmittal		transmittal,	¹
const	SE_URN	*	new_transmittal_name	²
);

Definition

Given the transmittal specified by transmittal, this function replaces the formal transmittal name associated with the transmittal to that specified by new_transmittal_name. This function can be used to supply the first name for a transmittal opened using SE_OpenTransmittalByLocation(), or to modify the name of a transmittal that was previously named or opened using SE_OpenTransmittalByName().

Details on the format of the transmittal name may be found under SE_ResolveTransmittalName().

CAUTION: While setting the transmittal name is desirable in many cases, care should be taken when invoking this function. The API is not responsible for managing configuration and changing control for the transmittal being modified. Calling this function will permanently change the transmittal name associated with the file containing the transmittal.

Returns

SE_RETCOD_SUCCESS	and the transmittal name is set.
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 transmittal name was successfully set.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INVALID_TRANSMITTAL_NAME	set if the new_transmittal_name parameter did not specify a name that was valid according to the formal SEDRIS namespace. See the comment in the SE_ResolveTransmittalName() function description about the nature of the validation done.
SE_STATCODE_INVALID_ACCESS_MODE	set if transmittal was opened in read-only mode.
SE_STATCODE_INACTIONABLE_FAILURE	set if the call fails for any other reason.

Parameters Notes

¹ handle to the transmittal for which the name should be set.

² a pointer to character array specifying a valid transmittal name in the formal SEDRIS namespace. This parameter is validated only based upon the structured format of the name string. That is, the sub-fields within the string are only checked for proper structure (character set, delimiters, etc.) and are NOT checked for consistency with namespace delegation rules, and proper use of transmittal versioning.