VpeSetTplFieldNullValueText

<< Click to Display Table of Contents >>

Navigation:  Templates >

VpeSetTplFieldNullValueText

Previous pageReturn to chapter overviewNext page

Sets the text which is printed for Fields that have a null-value. You can assign a special text to Fields with a null-value. By default, the null-value text is an empty string. You can specify for each field an individual null-value text, for example "n/a".

int VpeSetTplFieldNullValueText(

VpeHandle hTemplate,

LPCSTR data_source_prefix,

LPCSTR field_name,

LPSTR text

)

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

LPSTR text

pointer to a buffer that holds the string that shall be assigned to the Field's null-value text

Returns:

Value

Description

True

if the field's null-value text could be set

False

otherwise

Remarks:

The Template Object itself offers simple methods to access a Field's value directly, i.e. without retrieving a Field Object first. See VpeSetTplFieldNullValueText.

Example:

VpeSetTplFieldNullValueText(hTemplate, "Sample2", "Recipient:Company", "n/a");

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual