Field > VpeGetFieldDescription

Returns the description of the Field as defined in dycodoc.

void VpeGetFieldDescription(

VpeHandle hField,

LPSTR value,

UINT *size

)

VpeHandle hField

Field Handle

LPSTR value

Pointer to a buffer that receives the string with the description of the Field.
This parameter can be NULL, if the data is not required, in such case no data is copied.

UINT *size

Pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the value parameter. When the function returns, this variable contains the number of bytes copied to value - including the size of the terminating null character.

If value is NULL, and size is non-NULL, the function returns True and stores the size of the data, in bytes, in the variable pointed to by size. This lets an application determine the best way to allocate a buffer for the value's data.

Returns:

Value	Description
True	value retrieved successfully
False	value could not be retrieved (for example out of memory)

Example:

UINT uSize;

char szDescription[256];

uSize = sizeof(szDescription);

VpeGetFieldDescription(hField, szDescription, &uSize);