DGListGetItemText

Retrieves the text of a list box item. This function is obsolete, use DGListGetTabItemText instead.

    Int32 DGListGetItemText (
      short  dialId,
      short  item,
      short  listItem,
      char*  text,
      Int32  size
    );

Parameters

dialId

ID of the dialog or tab page. DG_TOP_MODAL specifies the topmost modal dialog.

 

item

1-based index of the dialog item.

 

listItem

1-based index of the list item. DG_LIST_TOP specifies the first item of the list, DG_LIST_BOTTOM specifies the last item of the list.

 

text

Pointer to the buffer to receive the text. This parameter can be NULL.

 

size

Size of the text buffer. If text is NULL, this parameter is ignored.

Return Values

The length of the item text (including the 0 terminator), or 0 if size is less than the size of the item text. DG_LIST_SEPARATOR is returned if the item is a separator line.

Use NULL for the text parameter to retrieve the necessary buffer size.

Remarks

Use DGListGetTabItemText to retrieve the text of a tabulator item. A tabulator item can contain icon also, which can be rertrieved by DGListGetTabItemIcon or DGListGetTabItemIconId.

Requirements

Version: DG 2.0.0 or later

Header: DG.h

Import Library: DG.lib [WIN]

Module: DGLib [MAC], DG.dll [WIN]

See Also

DG Functions, List Box
DGListSetTabItemText, DGListGetTabItemText, DGListSetTabItemIcon, DGListGetTabItemIcon, DGListSetTabItemIconId, DGListGetTabItemIconId