PK_TOPOL_local_r_t   


struct PK_TOPOL_local_r_s
    {
    PK_local_status_t    status;
    int                  n_error_entities;
    PK_ENTITY_t         *error_entities;
    };
typedef struct PK_TOPOL_local_r_s PK_TOPOL_local_r_t;



This structure is used to return the status of the local operation
and in the case of a failure, any associated entities.


When a call to the local operation returns a value of PK_ERROR_no_errors,
then the actual status of the operation is given by the status
field.

If a fault is indicated by the status field, then the number of
entities associated with the fault are given by the field
n_error_entities, and the entities are returned in the array
error_entities.

Description of fields:



status            This field indicates the overall state of
                    the local operation. See PK_local_status_t for
                    values and meanings.


n_error_entities The number of topological or geometric entities in
                   the error_entities array.


error_entities   If the status field of this return structure indicates a
                   failure, this array may contain topological or geometric
                   entities which are associated with the failure.

Error entities returned:
The error_entities array will contain the following entities according
to the value of the status field :


  PK_local_status_ok_c            : No entities

  PK_local_status_nocheck_c       : No entities

  PK_local_status_fail_c          : No entities

  PK_local_status_cant_get_pt_c   : 1 VERTEX   Failed to find new geometry for
                                               existing vertex.
                                    n FACEs    Failed to find geometry for
                                               new vertex.

  PK_local_status_cant_get_cu_c   : 1 EDGE     Failed to find new geometry for
                                               existing edge.
                                    n FACEs    Failed to find geometry for
                                               new edge.

  PK_local_status_side_cu_fail_c  : 1 EDGE     Failed to find side curve.

  PK_local_status_side_su_fail_c  : 1 FACE     Failed to create a side surface.

  PK_local_status_cant_get_su_c   : n FACEs    Unable to produce offset
                                               surfaces for these faces.
                                               No surface replacement is
                                               performed.

  PK_local_status_cant_offset_c   : 1 FACE     Failed to offset or face could
                                               not be deleted.

  PK_local_status_fa_fail_c       : 1 FACE     Face which failed check.

  PK_local_status_fa_fa_fail_c    : 2 FACEs    Pair of faces where
                                               inconsistency found.

  PK_local_status_ed_remains_c    : 1 EDGE     An existing edge should have
                                               disappeared
                                    n FACEs    A transient edge should have
                                               disappeared

  PK_local_status_point_contact_c : 1 VERTEX   Vertex where point contact has
                                               has been found.

  PK_local_status_not_supported_c : 1 FACE     Face that has currently
                                               unsupported combination of
                                               reference entities.

Any space allocated by Parasolid within this structure may be freed by
calling PK_TOPOL_local_r_f.