Function Name: Model ID From GMI

Definition

Given a Geometry Model Instance, retrieves the ID of the Model that contains the Geometry Model being instanced.

Returns

SE_SUCCESS - and the <Model>'s ID field is copied into *id_out_ptr, if valid parameters were passed in.

SE_NULL_REQUIRED_PARAMETER - and *id_out_ptr is left unaltered, if id_out_ptr is NULL.

SE_INVALID_OR_NULL_OBJECT - and *id_out_ptr is set to zero (0), if object_in is not a handle to a valid, active (i.e., unfreed) <Geometry Model Instance>.

SE_UNRESOLVED_START_OBJECT - and *id_out_ptr is set to zero (0), if object_in is unresolved.

SE_NO_OBJECT - and *id_out_ptr is set to zero (0), if

  1. object_in's associated <Geometry Model> cannot be found, or
  2. the associated <Geometry Model>'s <Model> cannot be found.

SE_UNRESOLVED_OBJECT - and *id_out_ptr is set to zero (0), if

  1. object_in's associated <Geometry Model> is unresolved and could not be resolved, or
  2. the associated <Geometry Model>'s <Model> is unresolved and could not be resolved.

SE_OUT_OF_MEMORY - and *id_out_ptr is set to zero (0), if memory could not be allocated during an intermediate operation.

SE_FAILURE - and *id_out_ptr is set to zero (0), if the <Model>'s fields could not be retrieved.

Prototype


extern SE_STATUS_CODE_ENUM
SE_ModelIDFromGMI
(
SE_OBJECT object_in, (notes)
SE_ID *id_out_ptr (notes)
);

Parameters Notes

object_in

 <Geometry Model Instance> whose <Model> we're identifying.

id_out_ptr

 pointer to variable in the user's memory space where the result is placed.
Prev: Model ID From FMI. Next: Model Name From FMI. Up:Index.