PK_PART_ask_groups_o_t

struct PK_PART_ask_groups_o_s
    {
    int                o_t_version;    --- version number of options structure
    PK_LOGICAL_t       want_groups;    --- whether groups to be returned
                                       --- (PK_LOGICAL_true)
    PK_GROUP_closure_t group_closure;  --- whether to restrict by closure
                                       --- (PK_GROUP_closure_any_c)
    PK_ATTDEF_array_t group_attdefs;   --- group attdefs (NULL, 0)
    PK_LOGICAL_t      any_group_attdef;--- whether any or all attdefs must be
                                       --- present (PK_LOGICAL_true)
    };
typedef struct PK_PART_ask_groups_o_s PK_PART_ask_groups_o_t;




This structure holds optional controls for PK_PART_ask_groups_2.

Used in:

PK_PART_ask_groups_2

Description of fields:


'want_groups'                   'n_groups', the number of groups satisfying the
                                conditions is always returned by
                                PK_PART_ask_groups_2 The 'want_groups' option
                                determines whether the array of 'groups' is
                                also returned.


'group_closure'                 If this is PK_GROUP_closure_any_c then the
                                function applies to all groups of the 'part'.
                                If this is set to PK_GROUP_closure_closed_c
                                then only closed groups of the 'part' are
                                considered and if it is set to
                                PK_GROUP_closure_open_c then only open groups
                                of the part are considered.


'group_attdefs'                 the set of groups may be restricted by
                                providing an array of 'group_attdefs'. If this
                                array of attdefs is provided then only groups
                                which have attributes of these attdefs will be
                                considered.


'any_group_attdef'              If the 'group_attdefs' array is not empty
                                then this option determines whether a group is
                                to be considered if it has an attribute of any
                                of the attdefs in 'group_attdefs'
                                (PK_LOGICAL_true), or whether it must have
                                attributes of all of the 'group_attdefs'
                                (PK_LOGICAL_false).