VpeGetFieldAsInteger

<< Click to Display Table of Contents >>

Navigation:  Field >

VpeGetFieldAsInteger

Previous pageReturn to chapter overviewNext page

Returns the value of a Field as integer.

int VpeGetFieldAsInteger(

VpeHandle hField,

int *value

)

VpeHandle hField

Field Handle

int *value

pointer to a variable that receives the value of the Field as integer when the function returns

Returns:

Value

Description

True

value retrieved successfully

False

value could not be retrieved (for example if the field contained pure text that could not be converted to an integer value)

Remarks:

The Template Object itself offers a simple method to access a Field's value directly, i.e. without retrieving a Field Object first. See VpeGetTplFieldAsInteger.

Example:

int value;

VpeGetFieldAsInteger(hField, &x);

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual