|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetUnresolvedObjectFromPublishedLabel |
|---|
| extern SE_Return_Code | ||||
| SE_GetUnresolvedObjectFromPublishedLabel | ||||
| ( | ||||
| const | SE_URN | * | transmittal_name, | 1 |
| const | SE_String | * | object_label, | 2 |
| SE_Encoding | encoding, | 3 | ||
| SE_Object | * | object | 4 | |
| ); | ||||
This function creates an unresolved reference to a DRM object based on the combination of transmittal_name and object_label as supported in the specified encoding.
This function does not validate the reference to ensure that it can be resolved. This behavior is intentional in order to allow referencing well known published DRM objects, without requiring the transmittal containing the DRM object to be accessible. Care must be taken to ensure the reference is indeed correct. The SE_ResolveObject() function is available to do this, but requires that the referenced transmittal be accessible.
| SE_RETCOD_SUCCESS | and the object is returned. |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set if valid parameters were specified and all operations succeeded. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_INVALID_TRANSMITTAL_NAME | set if the transmittal URN was not valid according to the SEDRIS URN syntax rules. |
| SE_STATCODE_INVALID_OBJECT_LABEL | set if object_label was not valid according to the label syntax rules. |
| SE_STATCODE_INACTIONABLE_FAILURE | set if the call fails for any reason. |
1 the fully qualified URN of the transmittal that contains the labeled object.
2 the label under which the object was published.
3 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. See also SE_GetEncoding().
4 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.
|