Skip to content

Latest commit

 

History

History
208 lines (174 loc) · 4.86 KB

ns-commctrl-litem.md

File metadata and controls

208 lines (174 loc) · 4.86 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:commctrl.tagLITEM
LITEM (commctrl.h)
Used to set and retrieve information about a link item.
*PLITEM
LITEM
LITEM structure [Windows Controls]
PLITEM
PLITEM structure pointer [Windows Controls]
commctrl/LITEM
commctrl/PLITEM
controls.LITEM
controls.inet_LITEM
inet_LITEM
inet_LITEM_cpp
controls\LITEM.htm
Controls
VS|Controls|~\controls\syslink\structures\litem.htm
12/05/2018
*PLITEM, LITEM, LITEM structure [Windows Controls], PLITEM, PLITEM structure pointer [Windows Controls], commctrl/LITEM, commctrl/PLITEM, controls.LITEM, controls.inet_LITEM, inet_LITEM, inet_LITEM_cpp
commctrl.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
Windows
LITEM, *PLITEM
19H1
tagLITEM
commctrl/tagLITEM
PLITEM
commctrl/PLITEM
LITEM
commctrl/LITEM
c++
APIRef
kbSyntax
HeaderDef
Commctrl.h
LITEM

LITEM structure

-description

Used to set and retrieve information about a link item.

-struct-fields

-field mask

Type: UINT

Combination of one or more of the following flags, describing the information to set or retrieve:

Value Meaning
LIF_ITEMINDEX
Retrieve the numeric item index. Items are always accessed by index, therefore you must always set this flag and assign a value to iLink. To obtain the item ID you must set both LIF_ITEMINDEX and LIF_ITEMID.
LIF_STATE
Use stateMask to get or set the state of the link.
LIF_ITEMID
Specify the item by the ID value given in szID.
LIF_URL
Set or get the URL for this item.

-field iLink

Type: int

Value of type int that contains the item index. This numeric index is used to access a SysLink control link.

-field state

Type: UINT

Combination of one or more of the following flags, describing the state of the item:

Value Meaning
LIS_ENABLED
The link can respond to user input. This is the default unless the entire control was created with WS_DISABLED. In this case, all links are disabled.
LIS_FOCUSED
The link has the keyboard focus. Pressing ENTER sends an NM_CLICK notification.
LIS_VISITED
The link has been visited by the user. Changing the URL to one that has not been visited causes this flag to be cleared.
LIS_HOTTRACK
Indicates that the syslink control will highlight in a different color (COLOR_HIGHLIGHT) when the mouse hovers over the control.
LIS_DEFAULTCOLORS
Enable custom text colors to be used.

-field stateMask

Type: UINT

Combination of flags describing which state item to get or set. Allowable items are identical to those allowed in state.

-field szID

Type: WCHAR[MAX_LINKID_TEXT]

WCHAR string that contains the ID name. The maximum number of characters in the array is MAX_LINKID_TEXT. The ID name cannot be used to access a SysLink control link. You use the item index to access the item.

-field szUrl

Type: WCHAR[L_MAX_URL_LENGTH]

WCHAR string that contains the URL represented by the link. The maximum number of characters in the array is L_MAX_URL_LENGTH.