[ROOT] --> C-Client

struct PEGroupOptions

Contains information about Groups in the report.

Source:
C:\FlatInclude\Crystal:Structures.h

Variables Index

condition
Specifies a pointer to the condition setting for the selected group section (date and Boolean fields only). See Crystal developers help for information on the condition constants.
discardOtherGroups
Determines whether the remaining groups are discarded or collected into an Others group.
fieldName
Specifies the field name of the group field.
keepGroupTogether
BOOL value, or PE_UNCHANGED for no change.
nTopOrBottomGroups
Number of groups to select.
repeatGroupHeader
BOOL value, or PE_UNCHANGED for no change.
sortDirection
Specifies one of the following sort directions (or PE_UNCHANGED for no change):
StructSize
Specifies the size of the PEGroupOptions structure. You must initialize the member to be the size of whatever it is, for example, groupOptions.StructSize = PE_SIZEOF_GROUP_OPTIONS. When setting, pass a PE_GC_constant, or PE_UNCHANGED for no change. When getting, use PE_GC_TYPEMASK and PE_GC_CONDITIONMASK to decode the condition.
topOrBottomNGroups
Use one of the following values a PE_GO_TBN_constant, or PE_UNCHANGED for no change.
topOrBottomNSortFieldName
Name of the summary field that the groups are ordered by. Remains empty for no change.


Variables

StructSize

WORD StructSize

Specifies the size of the PEGroupOptions structure. You must initialize the member to be the size of whatever it is, for example, groupOptions.StructSize = PE_SIZEOF_GROUP_OPTIONS. When setting, pass a PE_GC_constant, or PE_UNCHANGED for no change. When getting, use PE_GC_TYPEMASK and PE_GC_CONDITIONMASK to decode the condition.

condition

short condition

Specifies a pointer to the condition setting for the selected group section (date and Boolean fields only). See Crystal developers help for information on the condition constants.

fieldName

char fieldName [ PE_FIELD_NAME_LEN ]

Specifies the field name of the group field.

sortDirection

short sortDirection

Specifies one of the following sort directions (or PE_UNCHANGED for no change):

repeatGroupHeader

short repeatGroupHeader

BOOL value, or PE_UNCHANGED for no change.

keepGroupTogether

short keepGroupTogether

BOOL value, or PE_UNCHANGED for no change.

topOrBottomNGroups

short topOrBottomNGroups

Use one of the following values a PE_GO_TBN_constant, or PE_UNCHANGED for no change.

topOrBottomNSortFieldName

char topOrBottomNSortFieldName [ PE_FIELD_NAME_LEN ]

Name of the summary field that the groups are ordered by. Remains empty for no change.

nTopOrBottomGroups

short nTopOrBottomGroups

Number of groups to select.

discardOtherGroups

short discardOtherGroups

Determines whether the remaining groups are discarded or collected into an Others group.


Copyright (c) 2000 Dynalivery Corp.