SE GetSRFInfo

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

extern SE_Return_Code
SE_GetSRFInfo
(
SE_Object		object_in,	(notes)
SE_SRF_Info	*	SRF_params_out_ptr	(notes)
);

Definition

Gives the user the spatial reference frame (SRF) parameters currently being used when returning <Location> objects in the same SRF scope as the specified object.

See the SE_SetSRFInfo() function for more details.

The answer depends on the last call made to SE_SetSRFInfo() and/or SE_UseDefaultSRFInfo() and the manner in which the transmittal was produced.

case 1 - SE_SetSRFInfo() was called more recently than SE_UseDefaultSRFInfo()

The SRF defined by SE_SetSRFInfo() is still the current retrieval SRF, and that SRF's parameters will be returned in *SRF_params_out_ptr by this function. It doesn't matter what SRF was used to originally produce the given transmittal, since the SE_SetSRFInfo() function was used to over-ride any 'default' SRF choices and force all <Location> objects to be of the type specified by the current retrieval SRF.

case 2 - SE_UseDefaultSRFInfo() was called more recently than SE_SetSRFInfo(), or SE_SetSRFInfo() was never called.

In this case, the retrieval SRF that will be used to define <Location> objects 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_GetSRFInfo() will return SE_STAT_CODE_INACTIONABLE_FAILURE.

Returns

SE_RET_CODE_SUCCESS and the SRF parameters are 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 passed in and the call was successful.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if

the specified object has no scoping SRF, and either SE_UseDefaultSRFInfo() was called more recently than SE_SetSRFInfo() or SE_SetSRFInfo() was never called, or
the call failed for any other reason.

Parameters Notes

object_in

  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?"

SRF_params_out_ptr

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

SE_RET_CODE_SUCCESS	and the SRF parameters are returned.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.