VpeGetObjKind

<< Click to Display Table of Contents >>

Navigation:  VPE Object >

VpeGetObjKind

Previous pageReturn to chapter overviewNext page

By using this function, you can identify the type of an object.

long VpeGetObjKind(

VpeHandle hObject

)

VpeHandle hObject

VPE Object Handle

Returns:

Possible return codes are:

Constant Name

Value

Comment

VOBJID_NULL

16

not identified (should not occur)

VOBJID_LINE

17

 

VOBJID_POLYLINE

18

 

VOBJID_FRAME

19

 

VOBJID_TEXT

20

 

VOBJID_PICTURE

21

 

VOBJID_BARCODE

22

 

VOBJID_ELLIPSE

23

 

VOBJID_PIE

24

 

VOBJID_POLYGON

25

 

VOBJID_RTF

26

 

VOBJID_CHART

27

 

VOBJID_UDO

28

 

VOBJID_FORMFIELD

29

 

VOBJID_RESERVED

30

does not occur

VOBJID_DOCDATA

31

VPE document handle

VOBJID_CTRL_FORMFIELD

32

 

VOBJID_CTRL_CHECKBOX

33

 

VOBJID_CTRL_RADIOBUTTON

34

 

VOBJID_CTRL_RADIOBUTTONGROUP

35

 

VOBJID_RESERVED2

36

does not occur

VOBJID_RESERVED3

37

does not occur

VOBJID_DATA_MATRIX

38

 

VOBJID_MAXI_CODE

39

 

VOBJID_PDF417

40

 

VOBJID_AZTEC

41

 

VOBJID_QRCODE

42

 

 

Example:

// Returns the type name of a given VPE Object-ID:

char *GetObjectKindName(VpeHandle hObj)

{

 switch(VpeGetObjKind(hObj))

 {

 case VOBJID_LINE: return "Line";

 case VOBJID_POLYLINE: return "Polyline";

 case VOBJID_FRAME: return "Frame";

 case VOBJID_TEXT: return "Text";

 case VOBJID_PICTURE: return "Picture";

 case VOBJID_BARCODE: return "Barcode";

 case VOBJID_ELLIPSE: return "Ellipse";

 case VOBJID_PIE: return "Pie";

 case VOBJID_POLYGON: return "Polygon";

 case VOBJID_RTF: return "RTF";

 case VOBJID_CHART: return "Chart";

 case VOBJID_UDO: return "UDO";

 case VOBJID_FORMFIELD: return "FormField";

 case VOBJID_DOCDATA: return "Document Data";

 case VOBJID_CTRL_FORMFIELD: return "FormField Control";

 case VOBJID_CTRL_CHECKBOX: return "Checkbox Control";

 case VOBJID_CTRL_RADIOBUTTON: return "RadioButton Control";

 case VOBJID_CTRL_RADIOBUTTONGROUP: return "RadioButton Group Control";

 case VOBJID_DATA_MATRIX: return "DataMatrix 2D-Barcode";

 case VOBJID_MAXI_CODE: return "MaxiCode 2D-Barcode";

 case VOBJID_PDF417: return "PDF417 2D-Barcode";

 case VOBJID_AZTEC: return "Aztec 2D-Barcode";

 case VOBJID_QRCODE: return "QRCode 2D-Barcode";

 }

 

 return "NULL";

}

 

See Also:

"dycodoc Template Processing" in the Programmer's Manual