Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This structure is used to set and retrieve groups.

Syntax 

typedef struct LVGROUP {
  UINT 
cbSize;
  UINT 
mask;
  LPWSTR 
pszHeader;
  int 
cchHeader;
  LPWSTR 
pszFooter;
  int 
cchFooter;
  int 
iGroupId;
  UINT 
stateMask;
  UINT 
state;
  UINT 
uAlign;
} LVGROUP, *PLVGROUP;

Members

cbSize

Size of an LVGROUPstructure.

mask

Specifies which members of the structure are valid input. It can have one or more of the following values.

Value Description

LVGF_ALIGN

uAlignmember is valid.

LVGF_FOOTER

pszFooterand cchFootermembers are valid.

LVGF_GROUPID

iGroupIdmember is valid.

LVGF_HEADER

pszHeaderand cchHeadermembers are valid.

LVGF_NONE

No other items are valid.

LVGF_STATE

stateand stateMaskmembers are valid.
pszHeader

Pointer to a string that contains the header.

cchHeader

Number of characters in the string that specifies the header. This number should include the NULL terminator.

pszFooter

Pointer to a string that contains the footer.

cchFooter

Number of characters in the string that specifies the footer. This number should include the NULL terminator.

iGroupId

Identifier (ID) of the group.

stateMask

Reserved; must be zero.

state

Currently, it can only be the following.

Value Description

LVGS_NORMAL

Groups are expanded, the group name is displayed, and all items in the group are displayed.
uAlign

Indicates the alignment of the header or footer text for the group. It can have one or more of the following values. Use one of the header flags. Footer flags are optional.

Value Description

LVGA_FOOTER_CENTER

Footer text is centered horizontally in the window.

LVGA_FOOTER_LEFT

Footer text is aligned at the left of the window.

LVGA_FOOTER_RIGHT

Footer text is aligned at the right of the window.

LVGA_HEADER_CENTER

Header text is centered horizontally in the window.

LVGA_HEADER_LEFT

Header text is aligned at the left of the window.

LVGA_HEADER_RIGHT

Header text is aligned at the right of the window.

Requirements

Header commctrl.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also