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_RET_CODE_SUCCESS	and the object is returned.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS

set if valid parameters were specified and all operations succeeded.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INVALID_TRANSMITTAL_NAME	set if the transmittal URN was not valid according to the SEDRIS URN syntax rules.
SE_STAT_CODE_INVALID_OBJECT_LABEL	set if object_label_in was not valid according to the label syntax rules.
SE_STAT_CODE_INACTIONABLE_FAILURE	set if the call fails for any reason.

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.

encoding

 identifies the API implementation encoding
    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 encoding is NULL, then the API
    implementation encoding to be used must be statically bound at 
    compile time.

    See also SE_GetEncoding().

object_out_ptr

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

Prev: SE_GetUniqueTransmittalID. Next: SE_GetUserData. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™