SE PublishObject

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

extern SE_Return_Code
SE_PublishObject
(
	SE_Object		object,	¹
const	SE_String	*	label	²
);

Definition

Given the resolved DRM object specified by object, this function makes the DRM object available for ITR referencing by listing it as published within the transmittal under the label specified by label. If the DRM object has already been published with a different label, the new label is added to the list of labels for the DRM object. If the DRM object has already been published under the same label, the call shall return SE_RETCOD_SUCCESS and provide a string to be retrieved using SE_GetLastFunctionStatus().

A valid DRM object label shall obey the following label syntax rules:

consist only of letters, numbers, and underscores from the character set specified in ISO/IEC 646, and
begin with a letter.

The transmittal whose DRM object is to be edited must be explicitly opened in SE_AM_UPDATE or SE_AM_CREATE mode for this operation to succeed.

Returns

SE_RETCOD_SUCCESS	and the object is published.
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 all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT	set if object was not a resolved object.
SE_STATCODE_INVALID_OBJECT_LABEL	set if label does not adhere to the same lexical conventions as variables in ANSI C or is already in use.
SE_STATCODE_INVALID_ACCESS_MODE	set if object belongs to a transmittal opened in read-only mode.
SE_STATCODE_INACTIONABLE_FAILURE	set if call fails for any other reason.

Parameters Notes

¹ the handle of the object to be published.

² an SE_String containing the label under which the object should be published. The label must adhere to same lexical conventions as variables in ANSI C.