VpeGetFieldAsBoolean

<< Click to Display Table of Contents >>

Navigation:  Field >

VpeGetFieldAsBoolean

Previous pageReturn to chapter overviewNext page

Returns the value of a Field as boolean (integer).

int VpeGetFieldAsBoolean(

VpeHandle hField,

int *value

)

VpeHandle hField

Field Handle

int *value

pointer to a variable that receives the value of the Field as boolean integer when the function returns (0 = false; 1 = true)

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 VpeGetTplFieldAsBoolean.

Example:

int is_customer;

VpeGetFieldAsBoolean(hField, &is_customer);

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual