SE GetSRFContextInfo

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

extern SE_Return_Code
SE_GetSRFContextInfo
(
SE_Object		object_in,	¹
SE_SRF_Context_Info	*	SRF_params_out_ptr	²
);

Definition

This function returns in srf_context_info the SRF currently being used when returning <Location> instances in the same SRF scope as the DRM object specified by object.

More details are available under SE_SetSRFContextInfo().

The value of srf_context_info depends on the last call made to SE_SetSRFContextInfo() and/or SE_UseDefaultSRFContextInfo() and the manner in which the transmittal was produced.

case 1 - SE_SetSRFContextInfo() was called more recently than SE_UseDefaultSRFContextInfo()

The SRF defined by SE_SetSRFContextInfo() is still the current retrieval SRF, and that SRF's context information will be returned by this function. This indicates that the SRF used to originally produce the given transmittal was overridden by a call to the SE_SetSRFContextInfo() function.

case 2 - SE_UseDefaultSRFContextInfo() was called more recently than SE_SetSRFContextInfo(), or SE_SetSRFContextInfo() was never called.

In this case, the retrieval SRF that will be used to define <Location> instances from the given transmittal depends entirely on the transmittal. The retrieval SRF used to return data will be the retrieval SRF that was used when producing the transmittal. This is the default case. If the supplied object does not fall within the scope of any SRF, then the SRF parameters are undefined and SE_GetSRFContextInfo() will return SE_STATCODE_INACTIONABLE_FAILURE.

Returns

SE_RETCOD_SUCCESS	and the SE_SRF_Context_Info is returned.
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 call was successful.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_INPUT_OBJECT and no changes are made if object is an unresolved DRM object.

SE_STATCODE_DELETED_OBJECT and no changes are made if object has been removed from the transmittal in which it resided.

SE_STATCODE_INACTIONABLE_FAILURE and no changes are made if

object is not a handle to a valid DRM object,

object has no scoping SRF, and either SE_UseDefaultSRFContextInfo() was called more recently than SE_SetSRFContextInfo() or SE_SetSRFContextInfo() was never called, or

the call failed for any other reason.

Parameters Notes

¹ the object in the transmittal of which the user is asking the question "What are the parameters for/what is the SRF whose scope includes this object?"

² a pointer to the variable in the user's memory space where the answer will be stored.

SE_STATCODE_UNRESOLVED_INPUT_OBJECT	and no changes are made if object is an unresolved DRM object.
SE_STATCODE_DELETED_OBJECT	and no changes are made if object has been removed from the transmittal in which it resided.
SE_STATCODE_INACTIONABLE_FAILURE	and no changes are made if object is not a handle to a valid DRM object, object has no scoping SRF, and either SE_UseDefaultSRFContextInfo() was called more recently than SE_SetSRFContextInfo() or SE_SetSRFContextInfo() was never called, or the call failed for any other reason.