TFORMer SDK - DLL/Library
7.0
|
General functions which are mandatory for most applications. More...
Defines | |
#define | ERRCODE LONG |
Define the type for the error codes | |
#define | ErrOk S_OK |
Define error code for "no error" (ErrOk, 0) | |
Enumerations | |
enum | EVarType { eVarType_Text = 0, eVarType_Long = 1, eVarType_Float = 2, eVarType_Invalid } |
Defines the type of a DataField. More... | |
enum | EPrinterType { ePrinterType_Default = 0, ePrinterType_Win32, ePrinterType_Repository, ePrinterType_Cups, ePrinterType_PSFile, ePrinterType_HTML, ePrinterType_PDFFile, ePrinterType_PSPrinter, ePrinterType_TxtPrinter, ePrinterType_TxtFile, ePrinterType_ImageBmp, ePrinterType_ImageGif, ePrinterType_ImageJpg, ePrinterType_ImagePcx, ePrinterType_ImagePng, ePrinterType_ImageTga, ePrinterType_ImageTifSingle, ePrinterType_ImageTifMultiPage, ePrinterType_ZPLPrinter, ePrinterType_ZPLFile, ePrinterType_Invalid } |
This enumeration specifies the type of output generated by TFORMer SDK. More... | |
enum | EVarUsage { eVarUsage_NotUsed = 0, eVarUsage_Normal, eVarUsage_Calculated, eVarUsage_Parameter, eVarUsage_Invalid } |
Describes the usage of a DataField within a FormLayout. More... | |
Functions | |
HTFORM | TFormer_Init (HTFRepository hRepository) |
Allocates and initializes internal memory. | |
ERRCODE | TFormer_Exit (HTFORM pInstance) |
Frees system resources previously allocated with TFormer_Init. | |
void | TFormer_License (LPCSTR pszLicensee, DWORD dwKind, LONG nLicenses, LPCSTR pszLicenseKey) |
License this TFORMer SDK instance. | |
License Types | |
The license types for the TFORMer SDK (see TFormer_License). | |
#define | LICKIND_WORKSTATION 1 |
Workstation license. | |
#define | LICKIND_SITE 2 |
Site license. | |
#define | LICKIND_DEVELOPER 3 |
Developer license. | |
#define | LICKIND_OFFICE 4 |
Office license. | |
#define | LICKIND_WORKGROUP 5 |
Workgroup license. | |
#define | LICKIND_SERVER 6 |
Server license. |
General functions which are mandatory for most applications.
#define ERRCODE LONG |
Define the type for the error codes
#define ErrOk S_OK |
Define error code for "no error" (ErrOk, 0)
#define LICKIND_DEVELOPER 3 |
Developer license.
Supports the use of TFORMer SDK in client-applications for a certain number of redistributions.
#define LICKIND_OFFICE 4 |
Office license.
Supports a certain number of installations or users within one facility or site (located at a single postal address).
#define LICKIND_SERVER 6 |
Server license.
Supports a certain number of total users for a (web-)server based installation.
#define LICKIND_SITE 2 |
Site license.
Supports a certain number of installations or users within one facility or site (located at a single postal address).
#define LICKIND_WORKGROUP 5 |
Workgroup license.
Supports a certain number of installations or users within one facility or site (located at a single postal address).
#define LICKIND_WORKSTATION 1 |
Workstation license.
Supports exactly one installation on a machine which is identified via the system-id.
enum EPrinterType |
This enumeration specifies the type of output generated by TFORMer SDK.
Choose between direct printing (Win32, Repository, Cups, PostscriptPrinter, TextPrinter, ZPLPrinter) and other supported output formats (PostscriptFile, HtmlFile, PdfFile, TextFile, ZPL-file or the various image formats).
ePrinterType_Default |
The default output device type. The output device which will be used depends on the type of the FormLayout to be printed.
|
ePrinterType_Win32 |
Direct printing to a Windows printer via GDI-calls (Microsoft Windows only). |
ePrinterType_Repository |
The printer as defined in the Repository or stand-alone FormLayout. In the later case only the printer |
ePrinterType_Cups |
A CUPS printer (Linux and UNIX only). |
ePrinterType_PSFile |
This printer type generates PostScript output as file. The PostScript header and footer used for each page may be customized. See |
ePrinterType_HTML |
This printer type generates HTML output as file. Some aspects of the index page and the footer appended to each generated HTML page may be customized. See |
ePrinterType_PDFFile |
This printer type generates PDF output as file. |
ePrinterType_PSPrinter |
This printer type sends PostScript output directly to the specific printer. The PostScript header and footer used for each generated page may be customized. See |
ePrinterType_TxtPrinter |
This printer type sends ASCII output directly to the specific printer. |
ePrinterType_TxtFile |
This printer type generates ASCII output as file. |
ePrinterType_ImageBmp |
This printer type generates BMP image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number. |
ePrinterType_ImageGif |
This printer type generates GIF image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number. |
ePrinterType_ImageJpg |
This printer type generates JPG image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number. |
ePrinterType_ImagePcx |
This printer type generates PCX image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number. |
ePrinterType_ImagePng |
This printer type generates PNG image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number. |
ePrinterType_ImageTga |
This printer type generates TGA image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number. |
ePrinterType_ImageTifSingle |
This printer type generates TIFF image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number. |
ePrinterType_ImageTifMultiPage |
This printer type generates multi-page TIFF image files (one image contains all output pages). |
ePrinterType_ZPLPrinter |
This printer type sends ZPL-II (ZEBRA Printer Language) output directly to the specific printer. |
ePrinterType_ZPLFile |
This printer type generates ZPL-II (ZEBRA Printer Language) output as file. |
ePrinterType_Invalid |
Invalid or unspecified printer type. Do not use this value (internal use only). |
enum EVarType |
Defines the type of a DataField.
// Enumerate all DataFields in the Project HPROJECTVAR_ITERATOR it = TFormer_GetFirstProjectVarIt (hTForm, pszProjectName, &eCode); BOOL bProjectVarValid = (it != NULL); LPCSTR pszDataFieldName = NULL; // TYPE_E_ELEMENTNOTFOUND should not be treated as error if (eCode == TYPE_E_ELEMENTNOTFOUND) eCode = ErrOk; // iterate all DataFields while (bProjectVarValid && (eCode == ErrOk)) { // Query the DataField usage in the given FormLayout EVarUsage eVarUsage = TFormer_ProjectVarItGetUsage (hTForm, it, &eCode); if ((eVarUsage == eVarUsage_Normal) && (eCode == ErrOk)) { pszDataFieldName = TFormer_ProjectVarItGetName (it, &eCode); if (pszDataFieldName != NULL && eCode == ErrOk) printf (" %s\n", pszDataFieldName); } // get next DataField bProjectVarValid = (TFormer_GetNextProjectVarIt (it) == ErrOk); } // release iterator TFormer_FreeProjectVarIt (it);
eVarType_Text |
A text (string or character). This is the recommended DataFieldType. |
eVarType_Long |
An integer number. When reading a DataField of this type from a JobData it is converted automatically to an integer. In case of conversion errors the result is 0 (no error or exception will be raised). |
eVarType_Float |
A floating point number. When reading a DataField of this type from a JobData it is converted automatically to a floating point number. In case of conversion errors the result is 0 (no error or exception will be raised). |
eVarType_Invalid |
Invalid, internal use only. |
enum EVarUsage |
Describes the usage of a DataField within a FormLayout.
eVarUsage_NotUsed |
The \ref page_concepts_datafield "" is defined within the \ref page_concepts_project but is not used in the \ref page_concepts_formlayout "". |
eVarUsage_Normal |
A normal \ref page_concepts_datafield "". The DataField is in use by the FormLayout, its value is not modified. The DataField is just used as part of expressions or directly in text-, bar-code or picture elements. Therefore the value for this DataField may be provided by an external application or by the user. |
eVarUsage_Calculated |
The \ref page_concepts_datafield "" is computed automatically. The DataField is in use by the FormLayout and its value is modified. Usually this is done via pre- or post-expressions. Therefore the value for this DataField may not be provided by an external application or by the user. |
eVarUsage_Parameter |
This is a writable system-\ref page_concepts_datafield "" used by the \ref page_concepts_formlayout "". The value of this system-DataField may be provided by an external application or by the user (e.g. tfDocumentName). |
eVarUsage_Invalid |
Invalid. |
ERRCODE TFormer_Exit | ( | HTFORM | pInstance | ) |
Frees system resources previously allocated with TFormer_Init.
Frees system resources allocated by TFormer_Init. Call this function before exiting your application or if TFORMer SDK should be unloaded from memory. After this call the TFORMer SDK must be initialized again (with TFormer_Init) before using it.
pInstance | The instance provided by a previous call to TFormer_Init |
HTFORM TFormer_Init | ( | HTFRepository | hRepository | ) |
Allocates and initializes internal memory.
This function must be called after loading the TFORMer library. All other calls to the library must be performed after TFormer_Init. Each thread of your application (if multi-threaded) must call TFormer_Init and must use the returned handle for subsequent calls.
NULL
if an error occurredhRepository | Provide NULL in all cases. This parameter is used internally by TEC-IT to provide a handle to an already opened Repository. |
void TFormer_License | ( | LPCSTR | pszLicensee, |
DWORD | dwKind, | ||
LONG | nLicenses, | ||
LPCSTR | pszLicenseKey | ||
) |
License this TFORMer SDK instance.
The licensing method needs to be called prior to any call generating output (e.g. TFormer_Print). It is recommended to call this method once immediately after loading the TFORMer SDK. You will receive the license information from TEC-IT Datenverarbeitung GmbH after ordering (http://www.tec-it.com/order). All license values must be specified exactly as received from TEC-IT. The license kind, the number of licenses and the licensee string are checked against the license key.
pszLicensee | Licensee name (provided by TEC-IT) |
dwKind | License kind (provided by TEC-IT) |
nLicenses | Number of licenses (provided by TEC-IT) |
pszLicenseKey | License key (provided by TEC-IT) |
© 2006-2012 - all rights reserved by TEC-IT Datenverarbeitung GmbH |
![]() |
Generated on Tue Oct 23 2012 16:33:19 for TFORMer SDK - DLL/Library with doxygen 1.8.0 |