DGGetItemData
This function is obsolete.
Retrieves the user-specified data of a user control dialog item.
Int32 DGGetItemData (
short dialId,
short item,
void* userData,
Int32 offset,
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.
- userData
- Output parameter: the specified block of the user data. This parameter can be NULL.
- offset
- 0-based offset in the user data block.
- size
- Number of bytes to retrieve from the user data block, beginning at offset.
Return Values
The size of the whole item data field.
If the function parameters are incorrect or offset + size is larger than the size of the item data field, zero is returned.
Remarks
Every user control can have a block of data describing the visual appearance and the behavior of the item. Moreover, the application can store any other information in this block. DG makes a copy of the data so the application can free its memory after calling DGSetItemData.
Use NULL for the userData parameter to determine the total size of the user data block.
Requirements
- Version: DG 1.0.0 or later
- Header: DG.h
- Import Library: DG.lib [WIN]
- Module: DGLib [MAC], DG.dll [WIN]
