Function Name: Get Ending Node For Edge

Definition

Given a Feature Edge object, retrieve the Feature Node component of its Feature Edge Ending Node. Given a Geometry Edge object, retrieve the Geometry Node component of its Geometry Edge Ending Node.

Returns

SE_SUCCESS - and a handle to the requested object is placed in *result_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_NULL_REQUIRED_PARAMETER - and no changes are made, if result_out_ptr was NULL.

SE_INVALID_OR_NULL_OBJECT - and *result_out_ptr is set to NULL, if edge is not a handle to a valid, active (i.e., unfreed) <Feature Edge> or <Geometry Edge>.

SE_UNRESOLVED_START_OBJECT - and *result_out_ptr is set to NULL, if edge is unresolved.

SE_NO_OBJECT - and *result_out_ptr is set to NULL, if

  1. edge is a <Feature Edge>, but has no <Feature Edge Ending Node>,
  2. edge is a <Feature Edge>, but its <Feature Edge Ending Node> has no <Feature Node>,
  3. edge is a <Geometry Edge>, but has no <Geometry Edge Ending Node>,
  4. edge is a <Geometry Edge>, but its <Geometry Edge Ending Node> has no <Geometry Node>.

SE_UNRESOLVED_OBJECT - and *result_out_ptr is set to NULL, if

  1. edge is a <Feature Edge>, and either
    1. its <Feature Edge Ending Node> was unresolved and could not be resolved, or
    2. its <Feature Edge Ending Node>'s <Feature Node> was unresolved and could not be resolved
  2. edge is a <Geometry Edge>, and either
    1. its <Geometry Edge Ending Node> was unresolved and could not be resolved, or
    2. its <Geometry Edge Ending Node>'s <Geometry Node> was unresolved and could not be resolved

SE_OUT_OF_MEMORY - and *result_out_ptr is set to NULL, if memory allocation failed.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetEndingNodeForEdge
(
SE_OBJECT edge, (notes)
SE_OBJECT *result_out_ptr (notes)
);

Parameters Notes

edge

 the edge whose ending node is being retrieved

result_out_ptr

 pointer to variable in the user's memory space where the requested
 SE_OBJECT handle is placed. The user is responsible for calling
 SE_FreeObject() on *result_out_ptr when he or she is finished with it.
Prev: Get Data Table Signature. Next: Get Rearranged Image Data. Up:Index.