PK_FACE_pattern_r_t

struct PK_FACE_pattern_r_s
    {
    PK_pattern_result_t        result;
    int                        n_patterns;
    PK_FACE_pattern_data_r_t  *patterns;
    int                        n_error_topols;
    PK_TOPOL_t                *error_topols;
    };
typedef struct PK_FACE_pattern_r_s PK_FACE_pattern_r_t;



This data structure contains operation status and the patterning
results.

Used in:

PK_FACE_pattern
PK_FACE_pattern_r_f

Description of fields:



'result'            This status field indicates the overall state of
                    the patterning operations. Permitted values are :

                     PK_pattern_result_ok_c
                     PK_pattern_result_partial_c
                     PK_pattern_result_fail_c
                     PK_pattern_result_mixed_faces_c
                     PK_pattern_result_instanced_c
                     PK_pattern_result_invalid_set_c
                     PK_pattern_result_miss_geom_c



'n_patterns'       The length of the 'patterns' array.


'patterns'         The array of pattern instance results. If the 'result'
                   field indicates an error or a partial error, the individual
                   pattern result records (if returned) must be inspected.
                   If the pattern operation has not completely failed, the
                   number of elements in this array will be the same as the
                   number of pattern instances requested. In the case of the
                   PK_FACE_pattern function, the value of 'n_transforms'.


'n_error_topols'   The number of topological entities in the 'error_topols'
                   array.


'error_topols'     If the 'result' field of this return structure indicates a
                   failure, this array may contain topological entities which
                   are associated with the failure.

The function PK_FACE_pattern_r_f may be used to free associated memory.