The data types in the following list define the size and meaning of the parameters in the C API functions. All of the types that are pointers end in a PTR suffix. Those data types that begin with IN_ define Imagenation objects and data structures. Each of the data types are defined in the In_api.h file.
Type Definition
CHARPTR pointer to a character string
CHARPTRPTR pointer to a pointer to a character string
DOUBLE signed floating point number
DOUBLEPTR pointer to a signed floating point number
INTPTR pointer to a signed 16-bit integer
LONG signed 32-bit integer. Use ALL CAPS in your code.
LONGPTR pointer to a 32-bit integer
SHORTPTR pointer to a signed 16-bit integer
STDPTR pointer to a void
UINTPTR unsigned pointer to a 16-bit integer
ULONG unsigned 32-bit integer or a segment/offset address
ULONGPTR pointer to an unsigned 32-bit integer
USHORTPTR pointer to an unsigned 16-bit integer
IN_BOOL 16-bit Boolean value. In the C API function descriptions and examples, TRUE = 1 and FALSE = 0.
IN_BOOLPTR pointer to a 16-bit Boolean value
IN_CLIENTID identifier of a client application
IN_CLIENTID_PTR pointer to an identifier of a client application
IN_DOCUMENT unsigned long value for a root document identifier
IN_DOCUMENT_PTR pointer to an unsigned long value for a root document identifier
IN_DOCWIN unsigned long value for a document window identifier, represented as the docwinID variable.
IN_DOCWIN_PTR pointer to an unsigned long value for a document window identifier
IN_DTLWIN unsigned long value for a Detail window identifier
IN_DTLWIN_PTR pointer to an unsigned long value for a Detail window identifier
IN_FAX_DOCUMENT_PTR pointer to the IN_FAX_DOCUMENT data structure
IN_LANG_TABLE unsigned long value for a language table identifier
IN_LANG_TABLE_PTR pointer to an unsigned long value for a language table identifier
IN_LAYER unsigned long value for a layer identifier
IN_LAYER_PTR pointer to an unsigned long value for a layer identifier
IN_LAYER_INFO_PTR pointer to the IN_LAYER_INFO data structure
IN_MASK_TABLE unsigned long value for a mask table
IN_MASK_TABLE_PTR pointer to an unsigned long value for a mask table
IN_OBJECT unsigned long value that represents an object identifier (objectID) within Imagenation. The window object, document window, Reference window, Detail window, document, page, layer, vector object, and language table are all "objects". Depending on the function, these data types can be substituted for IN_OBJECT.
IN_OBJECT_PTR pointer to an unsigned long value that represents an object type within Imagenation
IN_PAGE unsigned long value for a page identifier
IN_PAGE_PTR pointer to an unsigned long value for a page identifier
IN_PENMAP_TABLE unsigned long value for pen mapping table
IN_PENMAP_TABLE_PTR pointer to an unsigned long value for pen mapping table
IN_REFWIN unsigned long value for a Reference window identifier
IN_REFWIN_PTR pointer to an unsigned long value for a Reference window identifier
IN_VECTOR unsigned long value for a vector object identifier
IN_VECTOR_PTR pointer to an unsigned long value for a vector object identifier
IN_WINOBJ unsigned long value for a window object identifier
IN_WINOBJ_PTR pointer to an unsigned long value for a window object identifier
Back to: Setting up a C API integration
See also