Function Name: Vector Magnitude

Definition

Computes the magnitude of a vector.

Returns

SE_COORD_SUCCESS - if valid parameters were passed in.

SE_COORD_INVALID_SOURCE_VECTOR - if vec_ptr is NULL.

SE_COORD_FAILURE - if result_out_ptr is NULL.

Prototype


extern SE_COORD_STATUS_CODE_ENUM
SE_VectorMagnitude
(
constSE_VECTOR_3_TYPE *vec_ptr, (notes)
SE_FLOAT64 *result_out_ptr (notes)
);

Parameters Notes

vec_ptr

 pointer to the vector operand.

result_out_ptr

 pointer to an SE_FLOAT64 variable in the user's memory space
 where the result will be stored.
Prev: Valid Vertical Datum. Next: Vector Mult By Scalar. Up:Index.