VpeGetFieldAsNumber

<< Click to Display Table of Contents >>

Navigation:  Field >

VpeGetFieldAsNumber

Previous pageReturn to chapter overviewNext page

Returns the value of a Field as number (double).

int VpeGetFieldAsNumber(

VpeHandle hField,

double *value

)

VpeHandle hField

Field Handle

double *value

pointer to a variable that receives the value of the Field as double 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 double 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 VpeGetTplFieldAsNumber.

Example:

double amount;

VpeGetFieldAsNumber(hField, &amount);

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual