SE GetUnresolvedObjectFromPublishedLabel

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetUnresolvedObjectFromPublishedLabel

extern SE_Status_Code
SE_GetUnresolvedObjectFromPublishedLabel
(
const	char	*	transmittal_name_in,	(notes)
const	char	*	object_label_in,	(notes)
const	char		implementation_identifier[],	(notes)
	SE_Object	*	object_out_ptr	(notes)
);

Definition

Creates an unresolvedreference to an object based on the combination of transmittal name and object label.

IMPORTANT
This function does not validate the reference to insure that it can be resolved. This behavior is intentional in order to allow referencing "well known" published objects, without requiring the transmittal containing the object to be accessible. Care must be taken to insure the reference is indeed correct. The SE_ResolveObject() function is available to do this, but will require that the referenced transmittal be accessible.

Returns

SE_STAT_CODE_SUCCESS and produces the requested handle in *object_out_ptr, if valid parameters were specified and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *object_out_ptr remains unaltered, if transmittal_name_in, object_label_in, or object_out_ptr is NULL, or if implementation_identifier is NULL but required.

SE_STAT_CODE_INVALID_TRANSMITTAL_NAME and *object_out_ptr is set to NULL, if the transmittal URN was not valid according to the SEDRIS URN syntax rules.

SE_STAT_CODE_INVALID_OBJECT_LABEL and *object_out_ptr is set to NULL, if object_label_in was not valid according to the label syntax rules.

SE_STAT_CODE_FAILURE and *object_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

transmittal_name_in

 the fully qualified URN of the transmittal that
    contains the labeled object.

object_label_in

 the label under which the object was published.

implementation_identifier

 identifies the API implementation
    to use when retrieving these objects.  If the specified API can't find
    the objects, then the API will return a status code indicating why they
    could not be found.  If implementation_identifier is NULL, then the API
    implementation to be used must be statically bound at compile time.

    See also SE_GetImplementationIdentifier().

object_out_ptr

 a pointer to an SE_Object variable from the user, in
     which the object handle will be stored.

SE_STAT_CODE_SUCCESS	and produces the requested handle in *object_out_ptr, if valid parameters were specified and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *object_out_ptr remains unaltered, if transmittal_name_in, object_label_in, or object_out_ptr is NULL, or if implementation_identifier is NULL but required.
SE_STAT_CODE_INVALID_TRANSMITTAL_NAME	and *object_out_ptr is set to NULL, if the transmittal URN was not valid according to the SEDRIS URN syntax rules.
SE_STAT_CODE_INVALID_OBJECT_LABEL	and *object_out_ptr is set to NULL, if object_label_in was not valid according to the label syntax rules.
SE_STAT_CODE_FAILURE	and *object_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.