SRM GetCorresponding2DSRF

SRM Reference Manual Functions SRM GetCorresponding2DSRF

extern SRM_Status_Code
SRM_GetCorresponding2DSRF
(
SRM_SRF_3D		srf_3D,	(notes)
SRM_SRF_2D	*	srf_2D_ptr	(notes)
);

Definition

Given a 3D spatial reference frame (SRF), retrieves the corresponding 2D SRF, if there is one.

Returns

SRM_STAT_CODE_SUCCESS and *srf_2D_ptr is set to the appropriate result, if valid parameters were passed in and srf_3D has a 2D equivalent.

SRM_STAT_CODE_FAILURE and *srf_2D_ptr is left unchanged, if srf_2D_ptr is NULL.

SRM_STAT_CODE_FAILURE and *srf_2D_ptr is left unchanged, if srf_3D was invalid or does not have a 2D equivalent.

Parameters Notes

srf_3D

 3D SRF for which we want the corresponding 2D SRF

srf_2D_ptr

 pointer to a variable, provided by the user, into which
    the corresponding 2D SRF's enumerant is copied, if there is one.

SRM_STAT_CODE_SUCCESS	and *srf_2D_ptr is set to the appropriate result, if valid parameters were passed in and srf_3D has a 2D equivalent.
SRM_STAT_CODE_FAILURE	and *srf_2D_ptr is left unchanged, if srf_2D_ptr is NULL.
SRM_STAT_CODE_FAILURE	and *srf_2D_ptr is left unchanged, if srf_3D was invalid or does not have a 2D equivalent.