Templates > VpeGetTplFieldAsBoolean

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

int VpeGetTplFieldAsBoolean(

VpeHandle hTemplate,

LPCSTR data_source_prefix,

LPCSTR field_name,

int *value

)

VpeHandle hTemplate

Template Handle

LPCSTR data_source_prefix

prefix of the Data Source, this is the unique name of a Data Source as defined in dycodoc

LPCSTR field_name

name of the Data Source Field

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 boolean value)

Example:

int is_customer;

VpeGetTplFieldAsBoolean(hTpl, "SomeTable", "IsCustomer", &is_customer);