VpeGetTplFieldAsInteger

<< Click to Display Table of Contents >>

Navigation:  Templates >

VpeGetTplFieldAsInteger

Previous pageReturn to chapter overviewNext page

Returns the value of a Field as integer.

int VpeGetTplFieldAsInteger(

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

Example:

int year;

VpeGetTplFieldAsInteger(hTpl, "SomeTable", "Year", &year);

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual