Graphisoft®

Dialog ManagerVersion: 2.0

UserControl::GetData

Retrieves the user data of the user control.

long GetData (
    void *              userData,
    long                offset,
    long                size
) const;

Parameters

userData
A previously allocated memory block for 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 Value

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.

Description

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. Use NULL for the userData parameter to determine the total size of the user data block.