SRM CreateSRFParametersPair

SRM Reference Manual Functions SRM CreateSRFParametersPair

extern SRM_Status_Code
SRM_CreateSRFParametersPair
(
const	SRM_SRF_Parameters	*	source_SRF_params_ptr,	(notes)
const	SRM_SRF_Parameters	*	dest_SRF_params_ptr,	(notes)
	SRM_SRF_Parameters_Pair	*	coord_op_params_ptr	(notes)
);

Definition

This function converts parameters from a given (source, destination) pair of SRFs into an internal structure that will be used to optimize repeated coordinate conversion calls between those two SRFs.

Note that horizontal and vertical datum transformations are not currently supported.

Returns

SRM_STAT_CODE_SUCCESS and *coord_op_params_ptr will be set to point to a structure allocated by this function if valid parameters were passed in and all operations succeeded.
The SRM_SRF_Parameters_Pair structure contains the optimized parameters for converting between the two SRFs. Do not attempt to access or modify this structure; simply call SRM_FreeSRFParametersPair() when finished with it (i.e., when you no longer need to convert coordinates between the two SRFs) in order to free the memory used by this structure.

SRM_STAT_CODE_INVALID_SOURCE_SRF_PARAMETERS and *coord_op_params_ptr is set to NULL, if source_SRF_params_ptr is NULL or if the source SRF parameters are invalid.

SRM_STAT_CODE_INVALID_DEST_SRF_PARAMETERS and *coord_op_params_ptr is set to NULL, if dest_SRF_params_ptr is NULL or if the destination SRF parameters are invalid.

SRM_STAT_CODE_INVALID_SRF_PAIR and no changes are made, if coord_op_params_ptr was NULL.

SRM_STAT_CODE_UNSUPPORTED and *coord_op_params_ptr is set to NULL, if a conversion is specified that is not supported.

SRM_STAT_CODE_FAILURE and *coord_op_params_ptr is set to NULL, if a structure to store the optimized conversion parameters cannot be allocated (if the program is out of memory).

Parameters Notes

source_SRF_params_ptr

 pointer to a structure already filled out
    by the user for the source SRF that the user wishes to
    convert from

dest_SRF_params_ptr

 pointer to a structure already filled out
    by the user for the destination SRF that the user wishes
    to convert to

coord_op_params_ptr

 a pointer to an SRM_SRF_Parameters_Pair in the user's
    memory space that will be initialized by this call

SRM_STAT_CODE_SUCCESS	and *coord_op_params_ptr will be set to point to a structure allocated by this function if valid parameters were passed in and all operations succeeded. The SRM_SRF_Parameters_Pair structure contains the optimized parameters for converting between the two SRFs. Do not attempt to access or modify this structure; simply call SRM_FreeSRFParametersPair() when finished with it (i.e., when you no longer need to convert coordinates between the two SRFs) in order to free the memory used by this structure.
SRM_STAT_CODE_INVALID_SOURCE_SRF_PARAMETERS	and *coord_op_params_ptr is set to NULL, if source_SRF_params_ptr is NULL or if the source SRF parameters are invalid.
SRM_STAT_CODE_INVALID_DEST_SRF_PARAMETERS	and *coord_op_params_ptr is set to NULL, if dest_SRF_params_ptr is NULL or if the destination SRF parameters are invalid.
SRM_STAT_CODE_INVALID_SRF_PAIR	and no changes are made, if coord_op_params_ptr was NULL.
SRM_STAT_CODE_UNSUPPORTED	and *coord_op_params_ptr is set to NULL, if a conversion is specified that is not supported.
SRM_STAT_CODE_FAILURE	and *coord_op_params_ptr is set to NULL, if a structure to store the optimized conversion parameters cannot be allocated (if the program is out of memory).