Templates > VpeGetTplFieldAsString

Returns the value of a Field as string.

int VpeGetTplFieldAsString(

VpeHandle hTemplate,

LPCSTR data_source_prefix,

LPCSTR field_name,

LPSTR value,

UINT *size

)

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 value

pointer to a buffer that receives the string. This parameter can be NULL, if the data is not required, in such case no data is copied

UINT *size

pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the value parameter. When the function returns, this variable contains the number of bytes copied to value - including the size of the terminating null character.

If value is NULL, and size is non-NULL, the function returns True and stores the size of the data, in bytes, in the variable pointed to by size. This lets an application determine the best way to allocate a buffer for the value's data.

Returns:

Value	Description
True	value retrieved successfully
False	value could not be retrieved (for example, the field was not found, or out of memory)

Example:

UINT uSize;

char szRecipientCompany[256];

uSize = sizeof(szRecipientCompany);

VpeGetTplFieldAsString(hTpl, "Sample2", "Recipient:Company", szRecipientCompany, &uSize);