VpeGetTplFieldAsNumber

<< Click to Display Table of Contents >>

Navigation:  Templates >

VpeGetTplFieldAsNumber

Previous pageReturn to chapter overviewNext page

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

int VpeGetTplFieldAsNumber(

VpeHandle hTemplate,

LPCSTR data_source_prefix,

LPCSTR field_name,

double *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

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)

Example:

double amount;

VpeGetTplFieldAsNumber(hTpl, "SomeTable", "Amount", &amount);

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual