VPE Object > VpeGetObjName

In dycodoc a unique name is assigned to each VPE Object. This function returns the name of a VPE Object as defined in dycodoc. The function works also for Field Objects and Control Objects.

void VpeGetObjName(

VpeHandle hObject,

LPSTR value,

UINT *size

)

VpeHandle hObject

VPE Object Handle

LPSTR value

Pointer to a buffer that receives the string with the Field name.
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.

Remarks:

This function does only return correct values for VPE Objects, Field Objects and Control Objects that reside in a template, and which have been inserted into the document using VpeDumpTemplate() / VpeDumpTemplatePage(). If you specify an object handle to a different object, the function does nothing.

The function allows that hObject may be NULL, in this case an empty string is returned.