VpeGetTplDataSourcePrefix

<< Click to Display Table of Contents >>

Navigation:  Templates >

VpeGetTplDataSourcePrefix

Previous pageReturn to chapter overviewNext page

Returns the prefix of the Data Source as defined in dycodoc.

void VpeGetTplDataSourcePrefix(

VpeHandle hTemplate,

long data_source_index,

LPSTR value,

UINT *size

)

VpeHandle hTemplate

Template Handle

long data_source_index

index into the array of available Data Sources
this value must be in the range between 0 and VpeGetTplDataSourceCount() - 1

LPSTR value

Pointer to a buffer that receives the string with the prefix of the Data Source.
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.

Example:

UINT uSize;

char szPrefix[256];

uSize = sizeof(szPrefix);

VpeGetTplDataSourcePrefix(hTpl, 0, szPrefix, &uSize);

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual